Python Scripting

Summary

This extension adds a new tab to the built-in scripting window in Opticks. This new tab in the scripting window allows you to write Python code from within Opticks. The extension adds approximately 9 new classes to Python to interface between Opticks and Python. This includes the ability to move Opticks image data back and forth to NumPy arrays, if NumPy is installed. It also includes the ability to create new windows in Opticks and modify what's displayed in those windows. You can also interface this extension with the built-in wizard ability of Opticks to create "one-click" buttons in Opticks that can run a very complicated Python script or series of Python scripts.

In order to fully utilize all the capabilities it is highly recommended that you also install NumPy into your Python installation. One of the easier ways to do this and get a bunch of other useful scientific and remote sensing capability for Python is to download and install the free Python(x,y) distribution.

How do I get started with Python?

1. Make sure you have a copy of Python installed. ( If you download the extension installers for Python 2.5 or Python 2.6, they have a bundled copy of Python included. )
   • This extension currently supports Python 2.4.X, Python 2.5.X or Python 2.6.X.
2. Download the appropriate version of the extension depending on the version of Python you wish to use. You can only install one version of the extension at a time for a given Opticks installation (for example you cannot install the version that targets Python 2.4.X and Python 2.5.X at the same time).
3. Learn how to install Opticks extensions.
4. Open up the "Scripting Window" in Opticks and find the "Python" tab. Start writing some Python code.
5. If you cannot find the "Python" tab in the "Scripting Window" that might be because the extension could not locate your existing installation of Python. In this case, set the PYTHONHOME environment variable to point to your existing installation of Python.

Using the Python interface

Help on the extension is available in the Python opticks module which can be accessed by typing:

or by looking in $OPTICKS_HOME/SupportFiles/site-packages at the .py source files. Further help on the SimpleAPI interface is available in the Opticks SDK help documentation under the Simple datacentric API module. There are plans in the future to bundle html documentation along with extension.

Sample Python Scripts

Head over to Sample Python Scripts.

Screenshots and Videos

TBD.

Older Releases

Stable Releases
Currently none

Release Candidates