astro py:docs

- Index
- Modules

### Navigation

- imexam v0.5 »

# imexam.connect Module

This is the main controlling class, it allows the user to connect to (at least) ds9 and the imexamine classes

## Classes

`Connect`([target, path, viewer, wait_time, ...]) | Connect to a display device to look at and examine images that are displayed within

# imexam.imexamine Module

This class implements IRAF/imexamine type capabilities

## Classes

`Imexamine`() | do imexamine like routines on the current frame

# imexam.ds9_viewer Module

This class supports communication with DS9 through the XPA

Some code in this class was adapted from pysao, which can be found at https://github.com/leejjoon/pysao. Specifically this package used the existing Cython implementation to the XPA and extended the calls to the other available XPA executables so that more functionality is added. The same information is available here: http://hea-www.harvard.edu/RD/xpa/client.html#xpaopen

Using Cython will allow for broader development of the code and produce faster runtimes for large datasets with repeated calls to the display manager.

XPA is licensed under LGPL, help can be found here: http://hea-www.cfa.harvard.edu/saord/xpa/help.html The current XPA can be downloaded from here: http://hea-www.harvard.edu/saord/xpa/

DS9 also supports the SAMP protocol, but that has not been fully implemented in this package. http://ds9.si.edu/doc/ref/samp.html

## Classes

`ds9`([target, path, wait_time, quit_ds9_on_del]) | A class which controls all interactions between the user and the ds9 window

# imexam.ginga_viewer Module

This class supports communication with a Ginga-based viewer.

For default key and mouse shortcuts in a Ginga window, see:
  https://ginga.readthedocs.org/en/latest/quickref.html

## Classes

`ginga_mp`([exam, close_on_del, logger]) | A ginga-based viewer that uses a matplotlib widget.