--- /srv/rebuilderd/tmp/rebuilderd3VhlVS/inputs/python-imexam-doc_0.9.1-6_all.deb +++ /srv/rebuilderd/tmp/rebuilderd3VhlVS/out/python-imexam-doc_0.9.1-6_all.deb ├── file list │ @@ -1,3 +1,3 @@ │ -rw-r--r-- 0 0 0 4 2023-11-28 09:08:03.000000 debian-binary │ -rw-r--r-- 0 0 0 4348 2023-11-28 09:08:03.000000 control.tar.xz │ --rw-r--r-- 0 0 0 39059604 2023-11-28 09:08:03.000000 data.tar.xz │ +-rw-r--r-- 0 0 0 39059284 2023-11-28 09:08:03.000000 data.tar.xz ├── control.tar.xz │ ├── control.tar │ │ ├── ./control │ │ │ @@ -1,13 +1,13 @@ │ │ │ Package: python-imexam-doc │ │ │ Source: imexam │ │ │ Version: 0.9.1-6 │ │ │ Architecture: all │ │ │ Maintainer: Debian Astronomy Team │ │ │ -Installed-Size: 42122 │ │ │ +Installed-Size: 42109 │ │ │ Depends: libjs-sphinxdoc (>= 7.2.2) │ │ │ Section: doc │ │ │ Priority: optional │ │ │ Multi-Arch: foreign │ │ │ Homepage: https://imexam.readthedocs.io │ │ │ Description: Simple interactive astronomical image examination and plotting (Doc) │ │ │ Imexam is an affiliated package of AstroPy. It was designed to be a │ │ ├── ./md5sums │ │ │ ├── ./md5sums │ │ │ │┄ Files differ ├── data.tar.xz │ ├── data.tar │ │ ├── file list │ │ │ @@ -154,19 +154,19 @@ │ │ │ -rw-r--r-- 0 root (0) root (0) 887902 2020-03-30 21:03:13.000000 ./usr/share/doc/python-imexam-doc/html/_static/surface_plot.png │ │ │ -rw-r--r-- 0 root (0) root (0) 27450 2020-03-30 21:03:13.000000 ./usr/share/doc/python-imexam-doc/html/_static/user_func_1.png │ │ │ -rw-r--r-- 0 root (0) root (0) 94844 2020-03-30 21:03:13.000000 ./usr/share/doc/python-imexam-doc/html/_static/user_func_2.png │ │ │ -rw-r--r-- 0 root (0) root (0) 123633 2020-03-30 21:03:13.000000 ./usr/share/doc/python-imexam-doc/html/_static/walkthrough-array.png │ │ │ -rw-r--r-- 0 root (0) root (0) 352085 2020-03-30 21:03:13.000000 ./usr/share/doc/python-imexam-doc/html/_static/walkthrough-ginga.png │ │ │ -rw-r--r-- 0 root (0) root (0) 700533 2020-03-30 21:03:13.000000 ./usr/share/doc/python-imexam-doc/html/_static/walkthrough-imexam.png │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/api/ │ │ │ --rw-r--r-- 0 root (0) root (0) 97564 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/api/imexam.connect.Connect.html │ │ │ --rw-r--r-- 0 root (0) root (0) 113619 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/api/imexam.ds9_viewer.ds9.html │ │ │ --rw-r--r-- 0 root (0) root (0) 10885 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/api/imexam.ginga_viewer.ginga.html │ │ │ --rw-r--r-- 0 root (0) root (0) 77418 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/api/imexam.ginga_viewer.ginga_general.html │ │ │ --rw-r--r-- 0 root (0) root (0) 89659 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/api/imexam.imexamine.Imexamine.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 96718 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/api/imexam.connect.Connect.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 107463 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/api/imexam.ds9_viewer.ds9.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 10644 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/api/imexam.ginga_viewer.ginga.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 76326 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/api/imexam.ginga_viewer.ginga_general.html │ │ │ +-rw-r--r-- 0 root (0) root (0) 84010 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/api/imexam.imexamine.Imexamine.html │ │ │ -rw-r--r-- 0 root (0) root (0) 45849 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/genindex.html │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/imexam/ │ │ │ -rw-r--r-- 0 root (0) root (0) 24891 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/imexam/comparison_iraf.html │ │ │ -rw-r--r-- 0 root (0) root (0) 31984 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/imexam/current_capability.html │ │ │ -rw-r--r-- 0 root (0) root (0) 6213 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/imexam/dependencies.html │ │ │ -rw-r--r-- 0 root (0) root (0) 41196 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/imexam/description.html │ │ │ -rw-r--r-- 0 root (0) root (0) 12439 2023-11-28 09:08:03.000000 ./usr/share/doc/python-imexam-doc/html/imexam/example1.html │ │ ├── ./usr/share/doc/python-imexam-doc/html/api/imexam.connect.Connect.html │ │ │ @@ -74,28 +74,28 @@ │ │ │
│ │ │ │ │ │
│ │ │

Connect

│ │ │
│ │ │
│ │ │ class imexam.connect.Connect(target=None, path=None, viewer='ds9', wait_time=10, quit_window=True, port=None)[source]
│ │ │ -

Bases: object

│ │ │ +

Bases: object

│ │ │

Connect to a display device to look at and examine images.

│ │ │

The control features below are a basic set that should be available │ │ │ in all display tools.

│ │ │

The class for the display tool should override them and add it’s own │ │ │ extra features.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • target (string, optional) – the viewer target name or id (default is to start a new │ │ │ instance of a DS9 window)

    • │ │ │

  • path (string, optional) – absolute path to the viewers executable

    • │ │ │

  • viewer (string, optional) – The name of the image viewer you want to use, DS9 is the default

    • │ │ │ -

  • wait_time (int, optional) – The time to wait for a connection to be eastablished before quitting

    • │ │ │ +

  • wait_time (int, optional) – The time to wait for a connection to be eastablished before quitting

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │
│ │ │ window
│ │ │

controls the viewers functions

│ │ │ @@ -677,15 +677,15 @@ │ │ │ set_plot_pars(key=None, item=None, value=None)[source] │ │ │

Set the chosen plot parameter with the provided value.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • key (String) – The value of the option key, should be a single letter or number

    • │ │ │

  • item (string) – The value of the parameter in the dictionary

    • │ │ │ -

  • value (float, string, int, bool) – What the parameters value should be set to

    • │ │ │ +

  • value (float, string, int, bool) – What the parameters value should be set to

    • │ │ │
│ │ │
│ │ │
│ │ │

Examples

│ │ │

set_plot_par(‘j’,’func’,’MexicanHat1D’)

│ │ │

where j is the key value during imexam │ │ │ func is the parameter you want to edit │ │ │ @@ -701,16 +701,16 @@ │ │ │

│ │ │
│ │ │ setlog(filename=None, on=True, level=20)[source]
│ │ │

Turn on and off logging to a logfile or the screen.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • filename (str, optional) – Name of the output file to record log information

    • │ │ │ -

  • on (bool, optional) – True by default, turn the logging on or off

    • │ │ │ +

  • filename (str, optional) – Name of the output file to record log information

    • │ │ │ +

  • on (bool, optional) – True by default, turn the logging on or off

    • │ │ │

  • level (logging class, optional) – set the level for logging messages, turn off screen messages │ │ │ by setting to logging.CRITICAL

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -7,28 +7,28 @@ │ │ │ │ * _«_ _p_r_e_v_i_o_u_s_ | │ │ │ │ * _i_m_e_x_a_m_ _v_0_._9_._1 » │ │ │ │ * _i_m_e_x_a_m_._c_o_n_n_e_c_t_ _M_o_d_u_l_e » │ │ │ │ * Connect │ │ │ │ ************ CCoonnnneecctt_?¶ ************ │ │ │ │ ccllaassss imexam.connect.Connect(ttaarrggeett==NNoonnee, ppaatthh==NNoonnee, vviieewweerr==''ddss99'', │ │ │ │ wwaaiitt__ttiimmee==1100, qquuiitt__wwiinnddooww==TTrruuee, ppoorrtt==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ - Bases: _o_b_j_e_c_t │ │ │ │ + Bases: object │ │ │ │ Connect to a display device to look at and examine images. │ │ │ │ The control features below are a basic set that should be available in │ │ │ │ all display tools. │ │ │ │ The class for the display tool should override them and add it’s own │ │ │ │ extra features. │ │ │ │ Parameters: │ │ │ │ * ttaarrggeett (ssttrriinngg,, ooppttiioonnaall) – the viewer target name or id │ │ │ │ (default is to start a new instance of a DS9 window) │ │ │ │ * ppaatthh (ssttrriinngg,, ooppttiioonnaall) – absolute path to the viewers │ │ │ │ executable │ │ │ │ * vviieewweerr (ssttrriinngg,, ooppttiioonnaall) – The name of the image viewer you │ │ │ │ want to use, DS9 is the default │ │ │ │ - * wwaaiitt__ttiimmee (_ii_nn_tt,, ooppttiioonnaall) – The time to wait for a connection │ │ │ │ + * wwaaiitt__ttiimmee (iinntt,, ooppttiioonnaall) – The time to wait for a connection │ │ │ │ to be eastablished before quitting │ │ │ │ window_¶ │ │ │ │ controls the viewers functions │ │ │ │ Type: │ │ │ │ a pointer to an object │ │ │ │ imexam_[_s_o_u_r_c_e_]_¶ │ │ │ │ controls the imexamine functions and options │ │ │ │ @@ -298,29 +298,29 @@ │ │ │ │ set_plot_pars(kkeeyy==NNoonnee, iitteemm==NNoonnee, vvaalluuee==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Set the chosen plot parameter with the provided value. │ │ │ │ Parameters: │ │ │ │ * kkeeyy (SSttrriinngg) – The value of the option key, should be a │ │ │ │ single letter or number │ │ │ │ * iitteemm (ssttrriinngg) – The value of the parameter in the │ │ │ │ dictionary │ │ │ │ - * vvaalluuee (_ff_ll_oo_aa_tt,, ssttrriinngg,, _ii_nn_tt,, _bb_oo_oo_ll) – What the parameters │ │ │ │ + * vvaalluuee (ffllooaatt,, ssttrriinngg,, iinntt,, bbooooll) – What the parameters │ │ │ │ value should be set to │ │ │ │ Examples │ │ │ │ set_plot_par(‘j’,’func’,’MexicanHat1D’) │ │ │ │ where j is the key value during imexam func is the parameter you │ │ │ │ want to edit MexicanHat1D is the name of the astropy function to │ │ │ │ use │ │ │ │ set_region(**aarrggss, ****kkwwaarrggss)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Display a region using the specifications in region_string. │ │ │ │ setlog(ffiilleennaammee==NNoonnee, oonn==TTrruuee, lleevveell==2200)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Turn on and off logging to a logfile or the screen. │ │ │ │ Parameters: │ │ │ │ - * ffiilleennaammee (_ss_tt_rr,, ooppttiioonnaall) – Name of the output file to │ │ │ │ + * ffiilleennaammee (ssttrr,, ooppttiioonnaall) – Name of the output file to │ │ │ │ record log information │ │ │ │ - * oonn (_bb_oo_oo_ll,, ooppttiioonnaall) – True by default, turn the logging │ │ │ │ + * oonn (bbooooll,, ooppttiioonnaall) – True by default, turn the logging │ │ │ │ on or off │ │ │ │ * lleevveell (llooggggiinngg ccllaassss,, ooppttiioonnaall) – set the level for │ │ │ │ logging messages, turn off screen messages by setting │ │ │ │ to logging.CRITICAL │ │ │ │ show_window_commands()_[_s_o_u_r_c_e_]_¶ │ │ │ │ Print the available commands for the selected display window. │ │ │ │ showme()_[_s_o_u_r_c_e_]_¶ │ │ ├── ./usr/share/doc/python-imexam-doc/html/api/imexam.ds9_viewer.ds9.html │ │ │ @@ -74,39 +74,39 @@ │ │ │
│ │ │ │ │ │
│ │ │

ds9

│ │ │
│ │ │
│ │ │ class imexam.ds9_viewer.ds9(target='', path='', wait_time=5, quit_ds9_on_del=True)[source]
│ │ │ -

Bases: object

│ │ │ +

Bases: object

│ │ │

Control all interactions between the user and the DS9 window.

│ │ │

The ds9() contructor takes a ds9 target as its main argument. │ │ │ If none is given, then a new window and process will be started.

│ │ │

DS9’s xpa access points are documented in the reference manual, │ │ │ but the can also be returned to the user with a call to xpaset.

│ │ │

http://hea-www.harvard.edu/saord/ds9/ref/xpa.html

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • target (string, optional) – the ds9 target name or id. If None or empty string, │ │ │ a new ds9 instance is created.

    • │ │ │

  • path (string, optional) – path of the ds9. Used only if a new ds9 is requested.

    • │ │ │ -

  • wait_time (float, optional) – waiting time before error is raised

    • │ │ │ +

  • wait_time (float, optional) – waiting time before error is raised

    • │ │ │

  • quit_ds9_on_del (boolean, optional) – If True, try to quit ds9 when this instance is deleted.

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │
│ │ │ wait_time
│ │ │

The waiting time before error is raised

│ │ │
│ │ │
Type:
│ │ │ -

float

│ │ │ +

float

│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ path
│ │ │ @@ -191,15 +191,15 @@ │ │ │ _ext │ │ │

Extension of the current image that is loaded. If one extension of an │ │ │ MEF file is loaded this will be 1 regardless of the extension that was │ │ │ specified (because DS9 and the XPA now see it as a single image and │ │ │ header)

│ │ │
│ │ │
Type:
│ │ │ -

int

│ │ │ +

int

│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ _extname
│ │ │ @@ -215,15 +215,15 @@ │ │ │
│ │ │
│ │ │ _extver
│ │ │

If available, the EXTVER of the MEF extension that is loaded, taken │ │ │ from the current data header

│ │ │
│ │ │
Type:
│ │ │ -

int

│ │ │ +

int

│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ _ds9_process
│ │ │ @@ -261,27 +261,27 @@ │ │ │ │ │ │
│ │ │
│ │ │ _numaxis
│ │ │

number of image planes, this is NAXIS

│ │ │
│ │ │
Type:
│ │ │ -

int

│ │ │ +

int

│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ _naxis
│ │ │

specific image plane displayed, defaulted to 1 image plane, most │ │ │ relevant to cube fits files

│ │ │
│ │ │
Type:
│ │ │ -

tuple

│ │ │ +

tuple

│ │ │
│ │ │
│ │ │
│ │ │ │ │ │

starter.

│ │ │

Notes

│ │ │

I think this is a quirk in the XPA communication. The xpans, and XPA │ │ │ @@ -464,28 +464,28 @@ │ │ │

Methods Documentation

│ │ │
│ │ │
│ │ │ alignwcs(on=True)[source]
│ │ │

align wcs.

│ │ │
│ │ │
Parameters:
│ │ │ -

on (bool) – Align the images using the WCS in their headers

│ │ │ +

on (bool) – Align the images using the WCS in their headers

│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │ │ │ │

Blink frames.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • blink (bool, optional) – Set to True to start blinking the frames which are open

    • │ │ │ -

  • interval (int) – Set interval equal to the length of pause for blinking

    • │ │ │ +

  • blink (bool, optional) – Set to True to start blinking the frames which are open

    • │ │ │ +

  • interval (int) – Set interval equal to the length of pause for blinking

    • │ │ │
│ │ │
│ │ │
│ │ │

Notes

│ │ │
│ │ │
blink_syntax=

Syntax: │ │ │ blink │ │ │ @@ -514,42 +514,42 @@ │ │ │

│ │ │
Parameters:
│ │ │
    │ │ │

  • color (string) – color must be set to one of the available DS9 color map names

    • │ │ │

  • load (string, optional) – set to the filename which is a valid colormap lookup table │ │ │ valid contrast values are from 0 to 10, and valid bias │ │ │ values are from 0 to 1

    • │ │ │ -

  • invert (bool, optional) – invert the colormap

    • │ │ │ -

  • save (bool, optional) – save the current colormap as a file

    • │ │ │ +

  • invert (bool, optional) – invert the colormap

    • │ │ │ +

  • save (bool, optional) – save the current colormap as a file

    • │ │ │

  • filename (string, optional) – the name of the file to save the colormap to

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ colorbar(on=True)[source]
│ │ │

turn the colorbar on the bottom of the window on and off.

│ │ │
│ │ │
Parameters:
│ │ │ -

on (bool) – Set to True to turn on the colorbar, False to turn it off

│ │ │ +

on (bool) – Set to True to turn on the colorbar, False to turn it off

│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ contour(on=True, construct=True)[source]
│ │ │

show contours on the window.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • on (bool) – Set to true to turn on contours

    • │ │ │ -

  • construct (bool, optional) – Will open the contour dialog box which has more options

    • │ │ │ +

  • on (bool) – Set to true to turn on contours

    • │ │ │ +

  • construct (bool, optional) – Will open the contour dialog box which has more options

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -566,24 +566,24 @@ │ │ │
│ │ │ crosshair(x=None, y=None, coordsys='physical', skyframe='wcs', skyformat='fk5', match=False, lock=False)[source]
│ │ │

Control the position of the crosshair in the current frame.

│ │ │

crosshair mode is turned on automatically

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • x (string or int) – The value of x is converted to a string for the call to XPA, │ │ │ +

  • x (string or int) – The value of x is converted to a string for the call to XPA, │ │ │ use a value here appropriate for the skyformat you choose

    • │ │ │ -

  • y (string or int) – The value of y is converted to a string for the call to XPA, │ │ │ +

  • y (string or int) – The value of y is converted to a string for the call to XPA, │ │ │ use a value here appropriate for the skyformat you choose

    • │ │ │

  • coordsys (string, optional) – The coordinate system your x and y are defined in

    • │ │ │

  • skyframe (string, optional) – If skyframe has “wcs” in it then skyformat is also sent to the XPA

    • │ │ │

  • skyformat (string, optional) – Used with skyframe, specifies the format of the coordinate │ │ │ which were given in x and y

    • │ │ │ -

  • match (bool, optional) – If set to True, then the wcs is matched for the frames

    • │ │ │ -

  • lock (bool, optional) – If set to True, then the frame is locked in wcs

    • │ │ │ +

  • match (bool, optional) – If set to True, then the wcs is matched for the frames

    • │ │ │ +

  • lock (bool, optional) – If set to True, then the frame is locked in wcs

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -591,16 +591,16 @@ │ │ │

move the cursor in the current frame to the specified image pixel.

│ │ │
│ │ │

selected regions will also be moved

│ │ │
│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • x (int) – pixel location x coordinate to move to

    • │ │ │ -

  • y (int) – pixel location y coordinate to move to

    • │ │ │ +

  • x (int) – pixel location x coordinate to move to

    • │ │ │ +

  • y (int) – pixel location y coordinate to move to

    • │ │ │

  • call (x and y are converted to strings for the) –

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │ @@ -617,15 +617,15 @@ │ │ │ │ │ │
│ │ │
│ │ │ frame(n=None)[source]
│ │ │

convenience function to change or report frames.

│ │ │
│ │ │
Parameters:
│ │ │ -

n (int, string, optional) – The frame number to open or change to. If the number specified │ │ │ +

n (int, string, optional) – The frame number to open or change to. If the number specified │ │ │ doesn’t exist, a new frame will be opened │ │ │ If nothing is specified, then the current frame number will be │ │ │ returned. The value of n is converted to a string before passing │ │ │ to the XPA

│ │ │
│ │ │
│ │ │

Examples

│ │ │ @@ -722,16 +722,16 @@ │ │ │
│ │ │ grid(on=True, param=False)[source]
│ │ │

convenience to turn the grid on and off.

│ │ │

grid can be flushed with many more options

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • on (bool, optional) – Will turn the grid overlay on in the current frame

    • │ │ │ -

  • param (bool, optional) – Will open the parameter dialog in DS9

    • │ │ │ +

  • on (bool, optional) – Will turn the grid overlay on in the current frame

    • │ │ │ +

  • param (bool, optional) – Will open the parameter dialog in DS9

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -752,16 +752,16 @@ │ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • fname (string, FITS object) – The name of the file to be loaded. You can specify the full │ │ │ extension in the name, such as │ │ │ filename_flt.fits or filename_flt.fits[1] │ │ │ You can also pass it an in-memory FITS object

    • │ │ │ -

  • extver (int, optional) – The extension to load (EXTVER in the header)

    • │ │ │ -

  • mecube (bool, optional) – If mecube is True, load the fits file as a cube into ds9

    • │ │ │ +

  • extver (int, optional) – The extension to load (EXTVER in the header)

    • │ │ │ +

  • mecube (bool, optional) – If mecube is True, load the fits file as a cube into ds9

    • │ │ │
│ │ │
│ │ │
│ │ │

Notes

│ │ │

To tell ds9 to open a file whose name or path includes spaces, │ │ │ surround the path with “{…}”, e.g.

│ │ │

% xpaset -p ds9 file “{foo bar/my image.fits}”

│ │ │ @@ -802,35 +802,35 @@ │ │ │

load 3 images into an RGBimage frame.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • red (string) – The name of the fits file loaded into the red channel

    • │ │ │

  • green (string) – The name of the fits file loaded into the green channel

    • │ │ │

  • blue (string) – The name of the fits file loaded into the blue channel

    • │ │ │ -

  • scale (bool) – If True, then each image will be scaled with zscale() after loading

    • │ │ │ -

  • lockwcs (bool) – If True, then the image positions will be locked to each other │ │ │ +

  • scale (bool) – If True, then each image will be scaled with zscale() after loading

    • │ │ │ +

  • lockwcs (bool) – If True, then the image positions will be locked to each other │ │ │ using the WCS information in their headers

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ make_region(infile, labels=False, header=0, textoff=10, size=5)[source]
│ │ │

make an input reg file with [x,y,comment] to a DS9 reg file.

│ │ │

the input file should contain lines specifying x,y,comment

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • infile (str) – input filename

    • │ │ │ -

  • labels (bool) – add labels to the regions

    • │ │ │ -

  • header (int) – number of header lines in text file to skip

    • │ │ │ -

  • textoff (int) – offset in pixels for labels

    • │ │ │ -

  • size (int) – size of the region type

    • │ │ │ +

  • infile (str) – input filename

    • │ │ │ +

  • labels (bool) – add labels to the regions

    • │ │ │ +

  • header (int) – number of header lines in text file to skip

    • │ │ │ +

  • textoff (int) – offset in pixels for labels

    • │ │ │ +

  • size (int) – size of the region type

    • │ │ │
│ │ │
│ │ │
│ │ │

Notes

│ │ │

only circular regions are supported currently

│ │ │
│ │ │ │ │ │ @@ -840,17 +840,17 @@ │ │ │

mark ds9 regions regions given an input list of tuples.

│ │ │
│ │ │

a convienence function, you can also use set_region

│ │ │
│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • input_points (iterator, a tuple, or list of tuples) – or a string: (x,y,comment),

    • │ │ │ +

  • input_points (iterator, a tuple, or list of tuples) – or a string: (x,y,comment),

    • │ │ │

  • ptype (string) – the reference system for the point locations, image|physical|fk5

    • │ │ │ -

  • size (int) – the size of the region marker

    • │ │ │ +

  • size (int) – the size of the region marker

    • │ │ │

  • textoff (string) – the offset for the comment text, if comment is empty │ │ │ it will not show

    • │ │ │
│ │ │
│ │ │
│ │ │

Notes

│ │ │

only circular regions are supported currently

│ │ │ @@ -860,22 +860,22 @@ │ │ │
│ │ │ match(coordsys='wcs', frame=True, crop=False, fslice=False, scale=False, bin=False, colorbar=False, smooth=False, crosshair=False)[source]
│ │ │

match all other frames to the current frame.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • coordsys (string, optional) – The coordinate system to use

    • │ │ │ -

  • frame (bool, optional) – Match all other frames to the current frame, using the set coordsys

    • │ │ │ -

  • crop (bool, optional) – Set the current image display area, using the set coordsys

    • │ │ │ -

  • fslice (bool, optional) – Match current slice in all frames

    • │ │ │ -

  • scale (bool, optional) – Match to the current scale for all frames

    • │ │ │ -

  • bin (bool, optional) – Match to the current binning for all frames

    • │ │ │ -

  • colorbar (bool, optional) – Match to the current colorbar for all frames

    • │ │ │ -

  • smooth (bool, optional) – Match to the current smoothing for all frames

    • │ │ │ -

  • crosshair (bool, optional) – Match the crosshair in all frames, using the current coordsys

    • │ │ │ +

  • frame (bool, optional) – Match all other frames to the current frame, using the set coordsys

    • │ │ │ +

  • crop (bool, optional) – Set the current image display area, using the set coordsys

    • │ │ │ +

  • fslice (bool, optional) – Match current slice in all frames

    • │ │ │ +

  • scale (bool, optional) – Match to the current scale for all frames

    • │ │ │ +

  • bin (bool, optional) – Match to the current binning for all frames

    • │ │ │ +

  • colorbar (bool, optional) – Match to the current colorbar for all frames

    • │ │ │ +

  • smooth (bool, optional) – Match to the current smoothing for all frames

    • │ │ │ +

  • crosshair (bool, optional) – Match the crosshair in all frames, using the current coordsys

    • │ │ │
│ │ │
│ │ │
│ │ │

Notes

│ │ │

You can only choose one of the options at a time, and the logic will │ │ │ select the first True option so set frame=False and something else in │ │ │ addition to your choice if you don’t want the default option.

│ │ │ @@ -895,16 +895,16 @@ │ │ │
│ │ │
│ │ │ panto_image(x, y)[source]
│ │ │

convenience function to change to x,y physical image coordinates.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • x (float) – X location in physical coords to pan to

    • │ │ │ -

  • y (float) – Y location in physical coords to pan to

    • │ │ │ +

  • x (float) – X location in physical coords to pan to

    • │ │ │ +

  • y (float) – Y location in physical coords to pan to

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -940,17 +940,17 @@ │ │ │
│ │ │ rotate(value=None, to=False)[source]
│ │ │

rotate the current frame (in degrees).

│ │ │

the current rotation is printed with no params

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • value (float [degrees]) – Rotate the current frame {value} degrees │ │ │ +

  • value (float [degrees]) – Rotate the current frame {value} degrees │ │ │ If value is 0, then the current rotation is printed

    • │ │ │ -

  • to (bool) – Rotate the current frame to the specified value

    • │ │ │ +

  • to (bool) – Rotate the current frame to the specified value

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -1042,36 +1042,36 @@ │ │ │ │ │ │
│ │ │
│ │ │ showpix(close=False)[source]
│ │ │

display the pixel value table, close window when done.

│ │ │
│ │ │
Parameters:
│ │ │ -

close (bool, optional) – If set to True, then the pixel table dialog window is closed

│ │ │ +

close (bool, optional) – If set to True, then the pixel table dialog window is closed

│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ snapsave(filename=None, format=None, resolution=100)[source]
│ │ │

Create a snap shot of the current window, save in specified format.

│ │ │

This function bypasses the XPA calling routines to avoid a bug with │ │ │ the X11/XPA interface. Instead is uses the os function which │ │ │ takes a snapshot of the specified window.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • filename (str, optional) – filename of output image, the extension in the filename can also be │ │ │ +

  • filename (str, optional) – filename of output image, the extension in the filename can also be │ │ │ used to specify the format. If no filename is specified, then the │ │ │ filename will be constructed from the name of the image displayed │ │ │ image with _snap.png appended.

    • │ │ │ -

  • format (str, optional) – available formats are fits, eps, gif, tiff, jpeg, png │ │ │ +

  • format (str, optional) – available formats are fits, eps, gif, tiff, jpeg, png │ │ │ If no format is specified the filename extension is used

    • │ │ │ -

  • resolution (int, optional) – 1 to 100, for jpeg images

    • │ │ │ +

  • resolution (int, optional) – 1 to 100, for jpeg images

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -7,34 +7,34 @@ │ │ │ │ * _«_ _p_r_e_v_i_o_u_s_ | │ │ │ │ * _i_m_e_x_a_m_ _v_0_._9_._1 » │ │ │ │ * _i_m_e_x_a_m_._c_o_n_n_e_c_t_ _M_o_d_u_l_e » │ │ │ │ * ds9 │ │ │ │ ************ ddss99_?¶ ************ │ │ │ │ ccllaassss imexam.ds9_viewer.ds9(ttaarrggeett=='''', ppaatthh=='''', wwaaiitt__ttiimmee==55, │ │ │ │ qquuiitt__ddss99__oonn__ddeell==TTrruuee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ - Bases: _o_b_j_e_c_t │ │ │ │ + Bases: object │ │ │ │ Control all interactions between the user and the DS9 window. │ │ │ │ The ds9() contructor takes a ds9 target as its main argument. If none is │ │ │ │ given, then a new window and process will be started. │ │ │ │ DS9’s xpa access points are documented in the reference manual, but the │ │ │ │ can also be returned to the user with a call to xpaset. │ │ │ │ _h_t_t_p_:_/_/_h_e_a_-_w_w_w_._h_a_r_v_a_r_d_._e_d_u_/_s_a_o_r_d_/_d_s_9_/_r_e_f_/_x_p_a_._h_t_m_l │ │ │ │ Parameters: │ │ │ │ * ttaarrggeett (ssttrriinngg,, ooppttiioonnaall) – the ds9 target name or id. If │ │ │ │ None or empty string, a new ds9 instance is created. │ │ │ │ * ppaatthh (ssttrriinngg,, ooppttiioonnaall) – path of the ds9. Used only if a new │ │ │ │ ds9 is requested. │ │ │ │ - * wwaaiitt__ttiimmee (_ff_ll_oo_aa_tt,, ooppttiioonnaall) – waiting time before error is │ │ │ │ + * wwaaiitt__ttiimmee (ffllooaatt,, ooppttiioonnaall) – waiting time before error is │ │ │ │ raised │ │ │ │ * qquuiitt__ddss99__oonn__ddeell (bboooolleeaann,, ooppttiioonnaall) – If True, try to quit │ │ │ │ ds9 when this instance is deleted. │ │ │ │ wait_time_¶ │ │ │ │ The waiting time before error is raised │ │ │ │ Type: │ │ │ │ - _f_l_o_a_t │ │ │ │ + float │ │ │ │ path_¶ │ │ │ │ The path to the DS9 executable │ │ │ │ Type: │ │ │ │ string │ │ │ │ _xpa_name_¶ │ │ │ │ The value in XPA_METHOD, the name of the DS9 window │ │ │ │ Type: │ │ │ │ @@ -63,25 +63,25 @@ │ │ │ │ string │ │ │ │ _ext_¶ │ │ │ │ Extension of the current image that is loaded. If one extension of │ │ │ │ an MEF file is loaded this will be 1 regardless of the extension │ │ │ │ that was specified (because DS9 and the XPA now see it as a single │ │ │ │ image and header) │ │ │ │ Type: │ │ │ │ - _i_n_t │ │ │ │ + int │ │ │ │ _extname_¶ │ │ │ │ If available, the EXTNAME of the MEF extension that is loaded, │ │ │ │ taken from the current data header │ │ │ │ Type: │ │ │ │ string │ │ │ │ _extver_¶ │ │ │ │ If available, the EXTVER of the MEF extension that is loaded, taken │ │ │ │ from the current data header │ │ │ │ Type: │ │ │ │ - _i_n_t │ │ │ │ + int │ │ │ │ _ds9_process_¶ │ │ │ │ Points to the ds9 process id on the system, returned by Popen, │ │ │ │ whenever this module starts DS9 │ │ │ │ Type: │ │ │ │ pointer │ │ │ │ _mef_file_¶ │ │ │ │ The file is a multi-extension fits file │ │ │ │ @@ -91,20 +91,20 @@ │ │ │ │ The file is a multiextension fits file, and one of the extensions │ │ │ │ contains at least 1 additional extension (3D or more) │ │ │ │ Type: │ │ │ │ bookean │ │ │ │ _numaxis_¶ │ │ │ │ number of image planes, this is NAXIS │ │ │ │ Type: │ │ │ │ - _i_n_t │ │ │ │ + int │ │ │ │ _naxis_¶ │ │ │ │ specific image plane displayed, defaulted to 1 image plane, most │ │ │ │ relevant to cube fits files │ │ │ │ Type: │ │ │ │ - _t_u_p_l_e │ │ │ │ + tuple │ │ │ │ starter. │ │ │ │ Notes │ │ │ │ I think this is a quirk in the XPA communication. The xpans, and XPA │ │ │ │ prefer to have all connections be of the same type. DS9 defaults to │ │ │ │ creating an INET connection. In some cases, if no IP address can be found │ │ │ │ for the computer, the startup can hang. In these cases, a local │ │ │ │ connection is preferred, which uses a unix filename for the socket. │ │ │ │ @@ -211,21 +211,21 @@ │ │ │ │ _z_o_o_m([par]) Zoom using the specified command. │ │ │ │ _z_o_o_m_t_o_f_i_t() Zoom to fit the image to the │ │ │ │ viewer. │ │ │ │ Methods Documentation │ │ │ │ alignwcs(oonn==TTrruuee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ align wcs. │ │ │ │ Parameters: │ │ │ │ - oonn (_bb_oo_oo_ll) – Align the images using the WCS in their headers │ │ │ │ + oonn (bbooooll) – Align the images using the WCS in their headers │ │ │ │ blink(bblliinnkk==TTrruuee, iinntteerrvvaall==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Blink frames. │ │ │ │ Parameters: │ │ │ │ - * bblliinnkk (_bb_oo_oo_ll,, ooppttiioonnaall) – Set to True to start blinking │ │ │ │ + * bblliinnkk (bbooooll,, ooppttiioonnaall) – Set to True to start blinking │ │ │ │ the frames which are open │ │ │ │ - * iinntteerrvvaall (_ii_nn_tt) – Set interval equal to the length of │ │ │ │ + * iinntteerrvvaall (iinntt) – Set interval equal to the length of │ │ │ │ pause for blinking │ │ │ │ Notes │ │ │ │ blink_syntax= │ │ │ │ Syntax: blink [true|false] [interval ] │ │ │ │ clear_contour()_[_s_o_u_r_c_e_]_¶ │ │ │ │ clear contours from the screen. │ │ │ │ close()_[_s_o_u_r_c_e_]_¶ │ │ │ │ @@ -235,72 +235,72 @@ │ │ │ │ Set the color map table, using a defined list of options. │ │ │ │ Parameters: │ │ │ │ * ccoolloorr (ssttrriinngg) – color must be set to one of the │ │ │ │ available DS9 color map names │ │ │ │ * llooaadd (ssttrriinngg,, ooppttiioonnaall) – set to the filename which is │ │ │ │ a valid colormap lookup table valid contrast values are │ │ │ │ from 0 to 10, and valid bias values are from 0 to 1 │ │ │ │ - * iinnvveerrtt (_bb_oo_oo_ll,, ooppttiioonnaall) – invert the colormap │ │ │ │ - * ssaavvee (_bb_oo_oo_ll,, ooppttiioonnaall) – save the current colormap as a │ │ │ │ + * iinnvveerrtt (bbooooll,, ooppttiioonnaall) – invert the colormap │ │ │ │ + * ssaavvee (bbooooll,, ooppttiioonnaall) – save the current colormap as a │ │ │ │ file │ │ │ │ * ffiilleennaammee (ssttrriinngg,, ooppttiioonnaall) – the name of the file to │ │ │ │ save the colormap to │ │ │ │ colorbar(oonn==TTrruuee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ turn the colorbar on the bottom of the window on and off. │ │ │ │ Parameters: │ │ │ │ - oonn (_bb_oo_oo_ll) – Set to True to turn on the colorbar, False to │ │ │ │ + oonn (bbooooll) – Set to True to turn on the colorbar, False to │ │ │ │ turn it off │ │ │ │ contour(oonn==TTrruuee, ccoonnssttrruucctt==TTrruuee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ show contours on the window. │ │ │ │ Parameters: │ │ │ │ - * oonn (_bb_oo_oo_ll) – Set to true to turn on contours │ │ │ │ - * ccoonnssttrruucctt (_bb_oo_oo_ll,, ooppttiioonnaall) – Will open the contour │ │ │ │ + * oonn (bbooooll) – Set to true to turn on contours │ │ │ │ + * ccoonnssttrruucctt (bbooooll,, ooppttiioonnaall) – Will open the contour │ │ │ │ dialog box which has more options │ │ │ │ contour_load(ffiilleennaammee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ load a contour file into the window. │ │ │ │ Parameters: │ │ │ │ ffiilleennaammee (ssttrriinngg) – The name of the file with the contour │ │ │ │ level defined │ │ │ │ crosshair(xx==NNoonnee, yy==NNoonnee, ccoooorrddssyyss==''pphhyyssiiccaall'', sskkyyffrraammee==''wwccss'', │ │ │ │ sskkyyffoorrmmaatt==''ffkk55'', mmaattcchh==FFaallssee, lloocckk==FFaallssee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Control the position of the crosshair in the current frame. │ │ │ │ crosshair mode is turned on automatically │ │ │ │ Parameters: │ │ │ │ - * xx (ssttrriinngg oorr _ii_nn_tt) – The value of x is converted to a │ │ │ │ + * xx (ssttrriinngg oorr iinntt) – The value of x is converted to a │ │ │ │ string for the call to XPA, use a value here │ │ │ │ appropriate for the skyformat you choose │ │ │ │ - * yy (ssttrriinngg oorr _ii_nn_tt) – The value of y is converted to a │ │ │ │ + * yy (ssttrriinngg oorr iinntt) – The value of y is converted to a │ │ │ │ string for the call to XPA, use a value here │ │ │ │ appropriate for the skyformat you choose │ │ │ │ * ccoooorrddssyyss (ssttrriinngg,, ooppttiioonnaall) – The coordinate system │ │ │ │ your x and y are defined in │ │ │ │ * sskkyyffrraammee (ssttrriinngg,, ooppttiioonnaall) – If skyframe has “wcs” in │ │ │ │ it then skyformat is also sent to the XPA │ │ │ │ * sskkyyffoorrmmaatt (ssttrriinngg,, ooppttiioonnaall) – Used with skyframe, │ │ │ │ specifies the format of the coordinate which were given │ │ │ │ in x and y │ │ │ │ - * mmaattcchh (_bb_oo_oo_ll,, ooppttiioonnaall) – If set to True, then the wcs │ │ │ │ + * mmaattcchh (bbooooll,, ooppttiioonnaall) – If set to True, then the wcs │ │ │ │ is matched for the frames │ │ │ │ - * lloocckk (_bb_oo_oo_ll,, ooppttiioonnaall) – If set to True, then the frame │ │ │ │ + * lloocckk (bbooooll,, ooppttiioonnaall) – If set to True, then the frame │ │ │ │ is locked in wcs │ │ │ │ cursor(xx==NNoonnee, yy==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ move the cursor in the current frame to the specified image pixel. │ │ │ │ selected regions will also be moved │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – pixel location x coordinate to move to │ │ │ │ - * yy (_ii_nn_tt) – pixel location y coordinate to move to │ │ │ │ + * xx (iinntt) – pixel location x coordinate to move to │ │ │ │ + * yy (iinntt) – pixel location y coordinate to move to │ │ │ │ * ccaallll (xx aanndd yy aarree ccoonnvveerrtteedd ttoo ssttrriinnggss ffoorr tthhee) – │ │ │ │ disp_header()_[_s_o_u_r_c_e_]_¶ │ │ │ │ Display the header of the current image to a DS9 window. │ │ │ │ embed()_[_s_o_u_r_c_e_]_¶ │ │ │ │ Embed the viewer in a notebook. │ │ │ │ frame(nn==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ convenience function to change or report frames. │ │ │ │ Parameters: │ │ │ │ - nn (_ii_nn_tt,, ssttrriinngg,, ooppttiioonnaall) – The frame number to open or │ │ │ │ + nn (iinntt,, ssttrriinngg,, ooppttiioonnaall) – The frame number to open or │ │ │ │ change to. If the number specified doesn’t exist, a new frame │ │ │ │ will be opened If nothing is specified, then the current │ │ │ │ frame number will be returned. The value of n is converted to │ │ │ │ a string before passing to the XPA │ │ │ │ Examples │ │ │ │ frame(1) sets the current frame to 1 frame(“last”) set the current │ │ │ │ frame to the last frame frame() returns the number of the current │ │ │ │ @@ -346,32 +346,32 @@ │ │ │ │ and the user has not deleted any through the gui. │ │ │ │ grab()_[_s_o_u_r_c_e_]_¶ │ │ │ │ Make a copy of the image view. │ │ │ │ grid(oonn==TTrruuee, ppaarraamm==FFaallssee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ convenience to turn the grid on and off. │ │ │ │ grid can be flushed with many more options │ │ │ │ Parameters: │ │ │ │ - * oonn (_bb_oo_oo_ll,, ooppttiioonnaall) – Will turn the grid overlay on in │ │ │ │ + * oonn (bbooooll,, ooppttiioonnaall) – Will turn the grid overlay on in │ │ │ │ the current frame │ │ │ │ - * ppaarraamm (_bb_oo_oo_ll,, ooppttiioonnaall) – Will open the parameter dialog │ │ │ │ + * ppaarraamm (bbooooll,, ooppttiioonnaall) – Will open the parameter dialog │ │ │ │ in DS9 │ │ │ │ hideme()_[_s_o_u_r_c_e_]_¶ │ │ │ │ lower the ds9 window. │ │ │ │ iscube()_[_s_o_u_r_c_e_]_¶ │ │ │ │ return whether a cube image is displayed in the current frame. │ │ │ │ load_fits(ffnnaammee, eexxttvveerr==NNoonnee, mmeeccuubbee==FFaallssee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ convenience function to load fits image to current frame. │ │ │ │ Parameters: │ │ │ │ * ffnnaammee (ssttrriinngg,, FFIITTSS oobbjjeecctt) – The name of the file to │ │ │ │ be loaded. You can specify the full extension in the │ │ │ │ name, such as filename_flt.fits or filename_flt.fits[1] │ │ │ │ You can also pass it an in-memory FITS object │ │ │ │ - * eexxttvveerr (_ii_nn_tt,, ooppttiioonnaall) – The extension to load (EXTVER │ │ │ │ + * eexxttvveerr (iinntt,, ooppttiioonnaall) – The extension to load (EXTVER │ │ │ │ in the header) │ │ │ │ - * mmeeccuubbee (_bb_oo_oo_ll,, ooppttiioonnaall) – If mecube is True, load the │ │ │ │ + * mmeeccuubbee (bbooooll,, ooppttiioonnaall) – If mecube is True, load the │ │ │ │ fits file as a cube into ds9 │ │ │ │ Notes │ │ │ │ To tell ds9 to open a file whose name or path includes spaces, │ │ │ │ surround the path with “{…}”, e.g. │ │ │ │ % xpaset -p ds9 file “{foo bar/my image.fits}” │ │ │ │ This is assuming that the image loads into the current or next new │ │ │ │ frame, watch the internal file and ext values because the user can │ │ │ │ @@ -393,83 +393,83 @@ │ │ │ │ Parameters: │ │ │ │ * rreedd (ssttrriinngg) – The name of the fits file loaded into │ │ │ │ the red channel │ │ │ │ * ggrreeeenn (ssttrriinngg) – The name of the fits file loaded into │ │ │ │ the green channel │ │ │ │ * bblluuee (ssttrriinngg) – The name of the fits file loaded into │ │ │ │ the blue channel │ │ │ │ - * ssccaallee (_bb_oo_oo_ll) – If True, then each image will be scaled │ │ │ │ + * ssccaallee (bbooooll) – If True, then each image will be scaled │ │ │ │ with zscale() after loading │ │ │ │ - * lloocckkwwccss (_bb_oo_oo_ll) – If True, then the image positions will │ │ │ │ + * lloocckkwwccss (bbooooll) – If True, then the image positions will │ │ │ │ be locked to each other using the WCS information in │ │ │ │ their headers │ │ │ │ make_region(iinnffiillee, llaabbeellss==FFaallssee, hheeaaddeerr==00, tteexxttooffff==1100, ssiizzee==55) │ │ │ │ _[_s_o_u_r_c_e_]_¶ │ │ │ │ make an input reg file with [x,y,comment] to a DS9 reg file. │ │ │ │ the input file should contain lines specifying x,y,comment │ │ │ │ Parameters: │ │ │ │ - * iinnffiillee (_ss_tt_rr) – input filename │ │ │ │ - * llaabbeellss (_bb_oo_oo_ll) – add labels to the regions │ │ │ │ - * hheeaaddeerr (_ii_nn_tt) – number of header lines in text file to │ │ │ │ + * iinnffiillee (ssttrr) – input filename │ │ │ │ + * llaabbeellss (bbooooll) – add labels to the regions │ │ │ │ + * hheeaaddeerr (iinntt) – number of header lines in text file to │ │ │ │ skip │ │ │ │ - * tteexxttooffff (_ii_nn_tt) – offset in pixels for labels │ │ │ │ - * ssiizzee (_ii_nn_tt) – size of the region type │ │ │ │ + * tteexxttooffff (iinntt) – offset in pixels for labels │ │ │ │ + * ssiizzee (iinntt) – size of the region type │ │ │ │ Notes │ │ │ │ only circular regions are supported currently │ │ │ │ mark_region_from_array(iinnppuutt__ppooiinnttss, ppttyyppee==''iimmaaggee'', tteexxttooffff==1100, ssiizzee==44) │ │ │ │ _[_s_o_u_r_c_e_]_¶ │ │ │ │ mark ds9 regions regions given an input list of tuples. │ │ │ │ a convienence function, you can also use set_region │ │ │ │ Parameters: │ │ │ │ - * iinnppuutt__ppooiinnttss (iitteerraattoorr,, aa ttuuppllee,, oorr _ll_ii_ss_tt ooff ttuupplleess) – │ │ │ │ + * iinnppuutt__ppooiinnttss (iitteerraattoorr,, aa ttuuppllee,, oorr lliisstt ooff ttuupplleess) – │ │ │ │ or a string: (x,y,comment), │ │ │ │ * ppttyyppee (ssttrriinngg) – the reference system for the point │ │ │ │ locations, image|physical|fk5 │ │ │ │ - * ssiizzee (_ii_nn_tt) – the size of the region marker │ │ │ │ + * ssiizzee (iinntt) – the size of the region marker │ │ │ │ * tteexxttooffff (ssttrriinngg) – the offset for the comment text, if │ │ │ │ comment is empty it will not show │ │ │ │ Notes │ │ │ │ only circular regions are supported currently │ │ │ │ match(ccoooorrddssyyss==''wwccss'', ffrraammee==TTrruuee, ccrroopp==FFaallssee, ffsslliiccee==FFaallssee, │ │ │ │ ssccaallee==FFaallssee, bbiinn==FFaallssee, ccoolloorrbbaarr==FFaallssee, ssmmooootthh==FFaallssee, ccrroosssshhaaiirr==FFaallssee) │ │ │ │ _[_s_o_u_r_c_e_]_¶ │ │ │ │ match all other frames to the current frame. │ │ │ │ Parameters: │ │ │ │ * ccoooorrddssyyss (ssttrriinngg,, ooppttiioonnaall) – The coordinate system to │ │ │ │ use │ │ │ │ - * ffrraammee (_bb_oo_oo_ll,, ooppttiioonnaall) – Match all other frames to the │ │ │ │ + * ffrraammee (bbooooll,, ooppttiioonnaall) – Match all other frames to the │ │ │ │ current frame, using the set coordsys │ │ │ │ - * ccrroopp (_bb_oo_oo_ll,, ooppttiioonnaall) – Set the current image display │ │ │ │ + * ccrroopp (bbooooll,, ooppttiioonnaall) – Set the current image display │ │ │ │ area, using the set coordsys │ │ │ │ - * ffsslliiccee (_bb_oo_oo_ll,, ooppttiioonnaall) – Match current slice in all │ │ │ │ + * ffsslliiccee (bbooooll,, ooppttiioonnaall) – Match current slice in all │ │ │ │ frames │ │ │ │ - * ssccaallee (_bb_oo_oo_ll,, ooppttiioonnaall) – Match to the current scale for │ │ │ │ + * ssccaallee (bbooooll,, ooppttiioonnaall) – Match to the current scale for │ │ │ │ all frames │ │ │ │ - * bbiinn (_bb_oo_oo_ll,, ooppttiioonnaall) – Match to the current binning for │ │ │ │ + * bbiinn (bbooooll,, ooppttiioonnaall) – Match to the current binning for │ │ │ │ all frames │ │ │ │ - * ccoolloorrbbaarr (_bb_oo_oo_ll,, ooppttiioonnaall) – Match to the current │ │ │ │ + * ccoolloorrbbaarr (bbooooll,, ooppttiioonnaall) – Match to the current │ │ │ │ colorbar for all frames │ │ │ │ - * ssmmooootthh (_bb_oo_oo_ll,, ooppttiioonnaall) – Match to the current │ │ │ │ + * ssmmooootthh (bbooooll,, ooppttiioonnaall) – Match to the current │ │ │ │ smoothing for all frames │ │ │ │ - * ccrroosssshhaaiirr (_bb_oo_oo_ll,, ooppttiioonnaall) – Match the crosshair in all │ │ │ │ + * ccrroosssshhaaiirr (bbooooll,, ooppttiioonnaall) – Match the crosshair in all │ │ │ │ frames, using the current coordsys │ │ │ │ Notes │ │ │ │ You can only choose one of the options at a time, and the logic │ │ │ │ will select the first True option so set frame=False and something │ │ │ │ else in addition to your choice if you don’t want the default │ │ │ │ option. │ │ │ │ nancolor(ccoolloorr==''rreedd'')_[_s_o_u_r_c_e_]_¶ │ │ │ │ set the not-a-number color, default is red. │ │ │ │ Parameters: │ │ │ │ ccoolloorr (ssttrriinngg) – The color to use for NAN pixels │ │ │ │ panto_image(xx, yy)_[_s_o_u_r_c_e_]_¶ │ │ │ │ convenience function to change to x,y physical image coordinates. │ │ │ │ Parameters: │ │ │ │ - * xx (_ff_ll_oo_aa_tt) – X location in physical coords to pan to │ │ │ │ - * yy (_ff_ll_oo_aa_tt) – Y location in physical coords to pan to │ │ │ │ + * xx (ffllooaatt) – X location in physical coords to pan to │ │ │ │ + * yy (ffllooaatt) – Y location in physical coords to pan to │ │ │ │ panto_wcs(xx, yy, ssyysstteemm==''ffkk55'')_[_s_o_u_r_c_e_]_¶ │ │ │ │ pan to wcs location coordinates in image. │ │ │ │ Parameters: │ │ │ │ * xx (ssttrriinngg) – The x location to move to, specified using │ │ │ │ the given system │ │ │ │ * yy (ssttrriinngg) – The y location to move to │ │ │ │ * ssyysstteemm (ssttrriinngg) – The reference system that x and y │ │ │ │ @@ -480,18 +480,18 @@ │ │ │ │ XPA returns strings of the form: u a 257.5 239 │ │ │ │ reopen()_[_s_o_u_r_c_e_]_¶ │ │ │ │ Reopen a closed window. │ │ │ │ rotate(vvaalluuee==NNoonnee, ttoo==FFaallssee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ rotate the current frame (in degrees). │ │ │ │ the current rotation is printed with no params │ │ │ │ Parameters: │ │ │ │ - * vvaalluuee (_ff_ll_oo_aa_tt [[ddeeggrreeeess]]) – Rotate the current frame │ │ │ │ + * vvaalluuee (ffllooaatt [[ddeeggrreeeess]]) – Rotate the current frame │ │ │ │ {value} degrees If value is 0, then the current │ │ │ │ rotation is printed │ │ │ │ - * ttoo (_bb_oo_oo_ll) – Rotate the current frame to the specified │ │ │ │ + * ttoo (bbooooll) – Rotate the current frame to the specified │ │ │ │ value │ │ │ │ run_inet_ds9()_[_s_o_u_r_c_e_]_¶ │ │ │ │ start a new ds9 window using an inet socket connection. │ │ │ │ Notes │ │ │ │ It is given a unique title so it can be identified later. │ │ │ │ save_regions(ffiilleennaammee==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ save the regions in the current window to a DS9 style regions file. │ │ │ │ @@ -525,31 +525,31 @@ │ │ │ │ show_xpa_commands()_[_s_o_u_r_c_e_]_¶ │ │ │ │ Print the available XPA commands. │ │ │ │ showme()_[_s_o_u_r_c_e_]_¶ │ │ │ │ raise the ds9 window. │ │ │ │ showpix(cclloossee==FFaallssee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ display the pixel value table, close window when done. │ │ │ │ Parameters: │ │ │ │ - cclloossee (_bb_oo_oo_ll,, ooppttiioonnaall) – If set to True, then the pixel table │ │ │ │ + cclloossee (bbooooll,, ooppttiioonnaall) – If set to True, then the pixel table │ │ │ │ dialog window is closed │ │ │ │ snapsave(ffiilleennaammee==NNoonnee, ffoorrmmaatt==NNoonnee, rreessoolluuttiioonn==110000)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Create a snap shot of the current window, save in specified format. │ │ │ │ This function bypasses the XPA calling routines to avoid a bug with │ │ │ │ the X11/XPA interface. Instead is uses the os function which takes │ │ │ │ a snapshot of the specified window. │ │ │ │ Parameters: │ │ │ │ - * ffiilleennaammee (_ss_tt_rr,, ooppttiioonnaall) – filename of output image, │ │ │ │ + * ffiilleennaammee (ssttrr,, ooppttiioonnaall) – filename of output image, │ │ │ │ the extension in the filename can also be used to │ │ │ │ specify the format. If no filename is specified, then │ │ │ │ the filename will be constructed from the name of the │ │ │ │ image displayed image with _snap.png appended. │ │ │ │ - * ffoorrmmaatt (_ss_tt_rr,, ooppttiioonnaall) – available formats are fits, │ │ │ │ + * ffoorrmmaatt (ssttrr,, ooppttiioonnaall) – available formats are fits, │ │ │ │ eps, gif, tiff, jpeg, png If no format is specified the │ │ │ │ filename extension is used │ │ │ │ - * rreessoolluuttiioonn (_ii_nn_tt,, ooppttiioonnaall) – 1 to 100, for jpeg images │ │ │ │ + * rreessoolluuttiioonn (iinntt,, ooppttiioonnaall) – 1 to 100, for jpeg images │ │ │ │ valid_data_in_viewer()_[_s_o_u_r_c_e_]_¶ │ │ │ │ return bool if valid file or array is loaded into the viewer. │ │ │ │ view(iimmgg)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Display numpy image array to current frame. │ │ │ │ Parameters: │ │ │ │ iimmgg (nnuummppyy aarrrraayy) – The array containing data, it will be │ │ │ │ forced to numpy.array() │ │ ├── ./usr/share/doc/python-imexam-doc/html/api/imexam.ginga_viewer.ginga.html │ │ │ @@ -90,19 +90,19 @@ │ │ │ Jupyter notebook.

│ │ │

initialize a general ginga viewer object.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • exam (imexam object) – This is the imexamine object which contains the examination │ │ │ functions

    • │ │ │ -

  • close_on_del (bool) – If True, the window connection shuts down when the object is │ │ │ +

  • close_on_del (bool) – If True, the window connection shuts down when the object is │ │ │ deleted

    • │ │ │

  • logger (logger object) – Ginga viewers all need a logger, if none is provided it will │ │ │ create one

    • │ │ │ -

  • port (int) – This is used as the communication port for the HTML5 viewer. The │ │ │ +

  • port (int) – This is used as the communication port for the HTML5 viewer. The │ │ │ user can choose to have multiple windows open at the same time │ │ │ as long as they have different port designations. If no port is │ │ │ specified, this class will choose an open port.

    • │ │ │
│ │ │
│ │ │
│ │ │

Methods Summary

│ │ │ ├── html2text {} │ │ │ │ @@ -22,19 +22,19 @@ │ │ │ │ a display front end. Using this you could create an analysis type │ │ │ │ environment on a server and view it via a browser or from a Jupyter │ │ │ │ notebook. │ │ │ │ initialize a general ginga viewer object. │ │ │ │ Parameters: │ │ │ │ * eexxaamm (iimmeexxaamm oobbjjeecctt) – This is the imexamine object which │ │ │ │ contains the examination functions │ │ │ │ - * cclloossee__oonn__ddeell (_bb_oo_oo_ll) – If True, the window connection shuts │ │ │ │ + * cclloossee__oonn__ddeell (bbooooll) – If True, the window connection shuts │ │ │ │ down when the object is deleted │ │ │ │ * llooggggeerr (llooggggeerr oobbjjeecctt) – Ginga viewers all need a logger, if │ │ │ │ none is provided it will create one │ │ │ │ - * ppoorrtt (_ii_nn_tt) – This is used as the communication port for the │ │ │ │ + * ppoorrtt (iinntt) – This is used as the communication port for the │ │ │ │ HTML5 viewer. The user can choose to have multiple windows │ │ │ │ open at the same time as long as they have different port │ │ │ │ designations. If no port is specified, this class will choose │ │ │ │ an open port. │ │ │ │ Methods Summary │ │ │ │ _c_l_o_s_e() Close the viewing window. │ │ │ │ _r_e_o_p_e_n() Reopen the viewer window if the user closes it accidentally. │ │ ├── ./usr/share/doc/python-imexam-doc/html/api/imexam.ginga_viewer.ginga_general.html │ │ │ @@ -68,15 +68,15 @@ │ │ │
│ │ │ │ │ │
│ │ │

ginga_general

│ │ │
│ │ │
│ │ │ class imexam.ginga_viewer.ginga_general(exam=None, close_on_del=True, logger=None, port=None)[source]
│ │ │ -

Bases: object

│ │ │ +

Bases: object

│ │ │

A base class which controls all interactions between the user and the │ │ │ ginga widget.

│ │ │

The ginga contructor creates a new window using the │ │ │ ginga backend.

│ │ │
│ │ │
Parameters:
│ │ │

close_on_del (boolean, optional) – If True, try to close the window when this instance is deleted.

│ │ │ @@ -105,19 +105,19 @@ │ │ │ │ │ │

initialize a general ginga viewer object.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • exam (imexam object) – This is the imexamine object which contains the examination │ │ │ functions

    • │ │ │ -

  • close_on_del (bool) – If True, the window connection shuts down when the object is │ │ │ +

  • close_on_del (bool) – If True, the window connection shuts down when the object is │ │ │ deleted

    • │ │ │

  • logger (logger object) – Ginga viewers all need a logger, if none is provided it will │ │ │ create one

    • │ │ │ -

  • port (int) – This is used as the communication port for the HTML5 viewer. The │ │ │ +

  • port (int) – This is used as the communication port for the HTML5 viewer. The │ │ │ user can choose to have multiple windows open at the same time │ │ │ as long as they have different port designations. If no port is │ │ │ specified, this class will choose an open port.

    • │ │ │
│ │ │
│ │ │
│ │ │

Methods Summary

│ │ │ @@ -289,16 +289,16 @@ │ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • color (string) – color must be set to one of the available color map names

    • │ │ │

  • load (string, optional) – set to the filename which is a valid colormap lookup table │ │ │ valid contrast values are from 0 to 10, and valid bias values are │ │ │ from 0 to 1

    • │ │ │ -

  • invert (bool, optional) – invert the colormap

    • │ │ │ -

  • save (bool, optional) – save the current colormap as a file

    • │ │ │ +

  • invert (bool, optional) – invert the colormap

    • │ │ │ +

  • save (bool, optional) – save the current colormap as a file

    • │ │ │

  • filename (string, optional) – the name of the file to save the colormap to

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │ @@ -418,15 +418,15 @@ │ │ │

Load fits image to current frame.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │

  • fname (string, FITS HDU) – The name of the file to be loaded. You can specify the full │ │ │ extension in the name, such as │ │ │ filename_flt.fits[sci,1] or filename_flt.fits[1]

    • │ │ │ -

  • extver (int, optional) – The extension to load (EXTVER in the header)

    • │ │ │ +

  • extver (int, optional) – The extension to load (EXTVER in the header)

    • │ │ │
│ │ │
│ │ │
│ │ │

Notes

│ │ │

Extname isn’t used here, ginga wants the absolute extension │ │ │ number, not the version number associated with a name

│ │ │
│ │ │ @@ -483,16 +483,16 @@ │ │ │
│ │ │
│ │ │ panto_image(x, y)[source]
│ │ │

Change to x,y physical image coordinates.

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • x (float) – X location in physical coords to pan to

    • │ │ │ -

  • y (float) – Y location in physical coords to pan to

    • │ │ │ +

  • x (float) – X location in physical coords to pan to

    • │ │ │ +

  • y (float) – Y location in physical coords to pan to

    • │ │ │
│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -519,15 +519,15 @@ │ │ │
│ │ │
│ │ │ rotate(value=None)[source]
│ │ │

Rotate the current frame (in degrees).

│ │ │

the current rotation is printed with no params

│ │ │
│ │ │
Parameters:
│ │ │ -

value (float [degrees]) – Rotate the current frame {value} degrees │ │ │ +

value (float [degrees]) – Rotate the current frame {value} degrees │ │ │ If value is None, then the current rotation is printed

│ │ │
│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ ├── html2text {} │ │ │ │ @@ -6,15 +6,15 @@ │ │ │ │ * _«_ _p_r_e_v_i_o_u_s │ │ │ │ * _i_m_e_x_a_m_ _v_0_._9_._1 » │ │ │ │ * _i_m_e_x_a_m_._c_o_n_n_e_c_t_ _M_o_d_u_l_e » │ │ │ │ * ginga_general │ │ │ │ ************ ggiinnggaa__ggeenneerraall_?¶ ************ │ │ │ │ ccllaassss imexam.ginga_viewer.ginga_general(eexxaamm==NNoonnee, cclloossee__oonn__ddeell==TTrruuee, │ │ │ │ llooggggeerr==NNoonnee, ppoorrtt==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ - Bases: _o_b_j_e_c_t │ │ │ │ + Bases: object │ │ │ │ A base class which controls all interactions between the user and the │ │ │ │ ginga widget. │ │ │ │ The ginga contructor creates a new window using the ginga backend. │ │ │ │ Parameters: │ │ │ │ cclloossee__oonn__ddeell (bboooolleeaann,, ooppttiioonnaall) – If True, try to close the window │ │ │ │ when this instance is deleted. │ │ │ │ view_[_s_o_u_r_c_e_]_¶ │ │ │ │ @@ -24,19 +24,19 @@ │ │ │ │ exam_¶ │ │ │ │ Type: │ │ │ │ imexamine object │ │ │ │ initialize a general ginga viewer object. │ │ │ │ Parameters: │ │ │ │ * eexxaamm (iimmeexxaamm oobbjjeecctt) – This is the imexamine object which │ │ │ │ contains the examination functions │ │ │ │ - * cclloossee__oonn__ddeell (_bb_oo_oo_ll) – If True, the window connection shuts │ │ │ │ + * cclloossee__oonn__ddeell (bbooooll) – If True, the window connection shuts │ │ │ │ down when the object is deleted │ │ │ │ * llooggggeerr (llooggggeerr oobbjjeecctt) – Ginga viewers all need a logger, if │ │ │ │ none is provided it will create one │ │ │ │ - * ppoorrtt (_ii_nn_tt) – This is used as the communication port for the │ │ │ │ + * ppoorrtt (iinntt) – This is used as the communication port for the │ │ │ │ HTML5 viewer. The user can choose to have multiple windows │ │ │ │ open at the same time as long as they have different port │ │ │ │ designations. If no port is specified, this class will choose │ │ │ │ an open port. │ │ │ │ Methods Summary │ │ │ │ _b_l_i_n_k() Blink multiple frames. │ │ │ │ _c_l_o_s_e() Close the window. │ │ │ │ @@ -139,16 +139,16 @@ │ │ │ │ options. │ │ │ │ Parameters: │ │ │ │ * ccoolloorr (ssttrriinngg) – color must be set to one of the │ │ │ │ available color map names │ │ │ │ * llooaadd (ssttrriinngg,, ooppttiioonnaall) – set to the filename which is │ │ │ │ a valid colormap lookup table valid contrast values are │ │ │ │ from 0 to 10, and valid bias values are from 0 to 1 │ │ │ │ - * iinnvveerrtt (_bb_oo_oo_ll,, ooppttiioonnaall) – invert the colormap │ │ │ │ - * ssaavvee (_bb_oo_oo_ll,, ooppttiioonnaall) – save the current colormap as a │ │ │ │ + * iinnvveerrtt (bbooooll,, ooppttiioonnaall) – invert the colormap │ │ │ │ + * ssaavvee (bbooooll,, ooppttiioonnaall) – save the current colormap as a │ │ │ │ file │ │ │ │ * ffiilleennaammee (ssttrriinngg,, ooppttiioonnaall) – the name of the file to │ │ │ │ save the colormap to │ │ │ │ contour_load()_[_s_o_u_r_c_e_]_¶ │ │ │ │ Load a file with contour information. │ │ │ │ crosshair(****kkwwaarrggss)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Control the current position of the crosshair in the frame. │ │ │ │ @@ -195,15 +195,15 @@ │ │ │ │ load_fits(ffnnaammee==NNoonnee, eexxttvveerr==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Load fits image to current frame. │ │ │ │ Parameters: │ │ │ │ * ffnnaammee (ssttrriinngg,, FFIITTSS HHDDUU) – The name of the file to be │ │ │ │ loaded. You can specify the full extension in the name, │ │ │ │ such as filename_flt.fits[sci,1] or filename_flt.fits │ │ │ │ [1] │ │ │ │ - * eexxttvveerr (_ii_nn_tt,, ooppttiioonnaall) – The extension to load (EXTVER │ │ │ │ + * eexxttvveerr (iinntt,, ooppttiioonnaall) – The extension to load (EXTVER │ │ │ │ in the header) │ │ │ │ Notes │ │ │ │ Extname isn’t used here, ginga wants the absolute extension number, │ │ │ │ not the version number associated with a name │ │ │ │ load_mef_as_cube(**aarrggss, ****kkwwaarrggss)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Load a Mult-Extension-Fits image one frame as a cube. │ │ │ │ load_mef_as_multi(**aarrggss, ****kkwwaarrggss)_[_s_o_u_r_c_e_]_¶ │ │ │ │ @@ -220,31 +220,31 @@ │ │ │ │ match(****kkwwaarrggss)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Match all other frames to the current frame. │ │ │ │ nancolor(****kkwwaarrggss)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Set the not-a-number (Nan) color. │ │ │ │ panto_image(xx, yy)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Change to x,y physical image coordinates. │ │ │ │ Parameters: │ │ │ │ - * xx (_ff_ll_oo_aa_tt) – X location in physical coords to pan to │ │ │ │ - * yy (_ff_ll_oo_aa_tt) – Y location in physical coords to pan to │ │ │ │ + * xx (ffllooaatt) – X location in physical coords to pan to │ │ │ │ + * yy (ffllooaatt) – Y location in physical coords to pan to │ │ │ │ panto_wcs(xx, yy, ssyysstteemm==''ffkk55'')_[_s_o_u_r_c_e_]_¶ │ │ │ │ Pan to wcs location coordinates in image │ │ │ │ Parameters: │ │ │ │ * xx (ssttrriinngg) – The x location to move to, specified using │ │ │ │ the given system │ │ │ │ * yy (ssttrriinngg) – The y location to move to │ │ │ │ * ssyysstteemm (ssttrriinngg) – The reference system that x and y │ │ │ │ were specified in, they should be understood by DS9 │ │ │ │ readcursor()_[_s_o_u_r_c_e_]_¶ │ │ │ │ Returns image coordinate postion and key pressed. │ │ │ │ rotate(vvaalluuee==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Rotate the current frame (in degrees). │ │ │ │ the current rotation is printed with no params │ │ │ │ Parameters: │ │ │ │ - vvaalluuee (_ff_ll_oo_aa_tt [[ddeeggrreeeess]]) – Rotate the current frame {value} │ │ │ │ + vvaalluuee (ffllooaatt [[ddeeggrreeeess]]) – Rotate the current frame {value} │ │ │ │ degrees If value is None, then the current rotation is │ │ │ │ printed │ │ │ │ save_header(**aarrggss, ****kkwwaarrggss)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Save the header of the current image to a file. │ │ │ │ save_regions(**aarrggss, ****kkwwaarrggss)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Save the displayed regions on the current window to a file. │ │ │ │ save_rgb(**aarrggss, ****kkwwaarrggss)_[_s_o_u_r_c_e_]_¶ │ │ ├── ./usr/share/doc/python-imexam-doc/html/api/imexam.imexamine.Imexamine.html │ │ │ @@ -74,15 +74,15 @@ │ │ │
│ │ │ │ │ │
│ │ │

Imexamine

│ │ │
│ │ │
│ │ │ class imexam.imexamine.Imexamine[source]
│ │ │ -

Bases: object

│ │ │ +

Bases: object

│ │ │

The imexamine class controls plotting and analysis functions.

│ │ │

do imexamine like routines on the current frame.

│ │ │

read the returned cursor key value to decide what to do

│ │ │

region_size is the default radius or side of the square for stat info

│ │ │

Methods Summary

│ │ │ │ │ │ │ │ │ @@ -225,18 +225,18 @@ │ │ │
│ │ │ aper_phot(x, y, data=None, genplot=True, fig=None, error=None)[source]
│ │ │

Perform aperture photometry.

│ │ │

Uses photutils functions, photutils must be available

│ │ │
│ │ │
Parameters:
│ │ │
    │ │ │ -

  • x (int) – The x location of the object

    • │ │ │ -

  • y (int) – The y location of the object

    • │ │ │ +

  • x (int) – The x location of the object

    • │ │ │ +

  • y (int) – The y location of the object

    • │ │ │

  • data (numpy array) – The data array to work on

    • │ │ │ -

  • genplot (bool) – plot the apertures to a figure; if false then the │ │ │ +

  • genplot (bool) – plot the apertures to a figure; if false then the │ │ │ tuple of (apertures, annulus_apertures,rawflux_table, sky_per_pix) │ │ │ is returned.

    • │ │ │

  • fig (figure object for redirect) – Used for interaction with the ginga GUI

    • │ │ │

  • error (float array) – If error is not None, then it should be given the │ │ │ error array for the corresponding data image. │ │ │ error is assumed to include all sources of error, │ │ │ including the Poisson error of the sources │ │ │ @@ -266,19 +266,19 @@ │ │ │

    │ │ │
    │ │ │ column_fit(x, y, data=None, form=None, genplot=True, fig=None)[source]
    │ │ │

    Compute the 1d fit to the column of data.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │

    • form (string) – This is the functional form specified in the column fit parameters

      • │ │ │ -

    • genplot (int) – produce the plot or return the fit model

      • │ │ │ +

    • genplot (int) – produce the plot or return the fit model

      • │ │ │

    • fig (figure name for redirect) – Used for interaction with the ginga GUI

      • │ │ │
    │ │ │
    │ │ │
    │ │ │

    Notes

    │ │ │

    delta is the range of data values to use around the x,y location

    │ │ │

    The background is currently ignored

    │ │ │ @@ -289,20 +289,20 @@ │ │ │
    │ │ │
    │ │ │ com_center(x, y, data=None, delta=None, oversampling=1.0)[source]
    │ │ │

    Return the center of mass of the object at x,y

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │ -

    • delta (int) – The range of data values (bounding box) to use around the x,y │ │ │ +

    • delta (int) – The range of data values (bounding box) to use around the x,y │ │ │ location for calculating the center

      • │ │ │ -

    • oversampling (int) – Oversampling factors of pixel indices. If oversampling │ │ │ +

    • oversampling (int) – Oversampling factors of pixel indices. If oversampling │ │ │ is a scalar this is treated as both x and y directions │ │ │ having the same oversampling factor; otherwise it is │ │ │ treated as (x_oversamp, y_oversamp)

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ @@ -310,32 +310,32 @@ │ │ │
    │ │ │
    │ │ │ contour(x, y, data=None, fig=None)[source]
    │ │ │

    plot contours in a region around the specified location.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │

    • fig (figure for redirect) – Used for interaction with the ginga GUI

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ curve_of_growth(x, y, data=None, genplot=True, fig=None)[source]
    │ │ │

    Display a curve of growth plot.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │

    • fig (figure name for redirect) – Used for interaction with the ginga GUI

      • │ │ │
    │ │ │
    │ │ │
    │ │ │

    Notes

    │ │ │

    the object photometry is taken from photutils

    │ │ │ @@ -344,52 +344,52 @@ │ │ │
    │ │ │
    │ │ │ cutout(x, y, data=None, size=None, fig=None)[source]
    │ │ │

    Make a fits cutout around the pointer location without wcs.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │ -

    • size (int) – The radius of the cutout region

      • │ │ │ +

    • size (int) – The radius of the cutout region

      • │ │ │

    • fig (figure for redirect) – Used for interaction with the ginga GUI

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ do_option(x, y, key)[source]
    │ │ │

    Run the imexam option.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the cursor or data point

      • │ │ │ -

    • y (int) – The y location of the cursor or data point

      • │ │ │ +

    • x (int) – The x location of the cursor or data point

      • │ │ │ +

    • y (int) – The y location of the cursor or data point

      • │ │ │

    • key (string) – The key which was pressed

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ gauss_center(x, y, data=None, delta=10, sigma_factor=0)[source]
    │ │ │

    Return the Gaussian 2D fit center of the object at (x,y).

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │ -

    • delta (int) – The range of data values (bounding box) to use around the x,y │ │ │ +

    • delta (int) – The range of data values (bounding box) to use around the x,y │ │ │ location for calculating the center

      • │ │ │ -

    • sigma_factor (float, optional) – The sigma clipping factor to use on the data fit

      • │ │ │ +

    • sigma_factor (float, optional) – The sigma clipping factor to use on the data fit

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -406,16 +406,16 @@ │ │ │
    │ │ │
    │ │ │ histogram(x, y, data=None, genplot=True, fig=None)[source]
    │ │ │

    Calulate a histogram of the data values.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int, required) – The x location of the object

      • │ │ │ -

    • y (int, required) – The y location of the object

      • │ │ │ +

    • x (int, required) – The x location of the object

      • │ │ │ +

    • y (int, required) – The y location of the object

      • │ │ │

    • data (numpy array, optional) – The data array to work on

      • │ │ │

    • genplot (boolean, optional) – If false, returns the hist, bin_edges tuple

      • │ │ │

    • fig (figure name for redirect) – Used for interaction with the ginga GUI

      • │ │ │
    │ │ │
    │ │ │
    │ │ │

    Notes

    │ │ │ @@ -429,22 +429,22 @@ │ │ │
    │ │ │
    │ │ │ line_fit(x, y, data=None, form=None, genplot=True, fig=None, col=False)[source]
    │ │ │

    compute the 1D fit to the line of data using the specified form.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │

    • form (string) – This is the functional form specified in the line fit parameters │ │ │ see show_fit_models()

      • │ │ │ -

    • genplot (bool) – produce the plot or return the fit

      • │ │ │ +

    • genplot (bool) – produce the plot or return the fit

      • │ │ │

    • fig (figure for redirect) – Used for interaction with the ginga GUI

      • │ │ │ -

    • col (bool (False)) – Plot column instead of line

      • │ │ │ +

    • col (bool (False)) – Plot column instead of line

      • │ │ │
    │ │ │
    │ │ │
    │ │ │

    Notes

    │ │ │

    The background is currently ignored

    │ │ │

    If centering is True in the parameter set, then the center │ │ │ is fit with a 2d gaussian, not performed for Polynomial1D

    │ │ │ @@ -465,46 +465,46 @@ │ │ │
    │ │ │ option_descrip(key, field=1)[source]
    │ │ │

    Return the looked up dictionary of options.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │

    • key (string) – The key which was pressed, it relates to the function to call

      • │ │ │ -

    • field (int) – This tells where in the option dictionary the function name │ │ │ +

    • field (int) – This tells where in the option dictionary the function name │ │ │ can be found

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ plot_column(x, y, data=None, fig=None)[source]
    │ │ │

    column plot of data at point y.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │

    • fig (figure name for redirect) – Used for interaction with the ginga GUI

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ plot_line(x, y, data=None, fig=None)[source]
    │ │ │

    line plot of data at point x.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │

    • fig (figure object for redirect) – Used for interaction with the ginga GUI

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ @@ -522,31 +522,31 @@ │ │ │ If pixel is True, then every pixel at each radius is plotted. │ │ │ If pixel is False, then the sum of all pixels in integer bins is plotted

    │ │ │

    Background may be subtracted and centering can be done with a │ │ │ 2D Gaussian fit. These options are read from the plot parameters dict.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │

    • form (string) – The string name of the form of the fit to use

      • │ │ │ -

    • genplot (bool) – Generate the plot if True, else retfurn the fit data

      • │ │ │ +

    • genplot (bool) – Generate the plot if True, else retfurn the fit data

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ register(user_funcs)[source]
    │ │ │

    register a new imexamine function made by the user as an option.

    │ │ │
    │ │ │
    Parameters:
    │ │ │ -

    user_funcs (dict) – Contains a dictionary where each key is the binding for the │ │ │ +

    user_funcs (dict) – Contains a dictionary where each key is the binding for the │ │ │ (function,description) tuple

    │ │ │
    │ │ │
    │ │ │

    Notes

    │ │ │

    The new binding will be added to the dictionary of imexamine functions │ │ │ as long as the key is unique. The new functions do not have to have │ │ │ default dictionaries associated with them.

    │ │ │ @@ -556,16 +556,16 @@ │ │ │
    │ │ │ report_stat(x, y, data=None)[source]
    │ │ │

    report the statisic of values in a box with side region_size.

    │ │ │

    The statistic can be any numpy function

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │ @@ -710,16 +710,16 @@ │ │ │
    │ │ │
    │ │ │ setlog(filename=None, on=True, level=20)[source]
    │ │ │

    Turn on and off logging to a logfile or the screen.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • filename (str, optional) – Name of the output file to record log information

      • │ │ │ -

    • on (bool, optional) – True by default, turn the logging on or off

      • │ │ │ +

    • filename (str, optional) – Name of the output file to record log information

      • │ │ │ +

    • on (bool, optional) – True by default, turn the logging on or off

      • │ │ │

    • level (logging class, optional) – set the level for logging messages, turn off screen messages │ │ │ by setting to logging.CRITICAL

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │ @@ -732,31 +732,31 @@ │ │ │
    │ │ │
    │ │ │ show_xy_coords(x, y, data=None)[source]
    │ │ │

    print the x,y,value to the screen.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ surface(x, y, data=None, fig=None)[source]
    │ │ │

    plot a surface around the specified location.

    │ │ │
    │ │ │
    Parameters:
    │ │ │
      │ │ │ -

    • x (int) – The x location of the object

      • │ │ │ -

    • y (int) – The y location of the object

      • │ │ │ +

    • x (int) – The x location of the object

      • │ │ │ +

    • y (int) – The y location of the object

      • │ │ │

    • data (numpy array) – The data array to work on

      • │ │ │

    • fig (figure for redirect) – Used for interaction with the ginga GUI

      • │ │ │
    │ │ │
    │ │ │
    │ │ │
    │ │ │ ├── html2text {} │ │ │ │ @@ -6,15 +6,15 @@ │ │ │ │ * _n_e_x_t_ _» │ │ │ │ * _«_ _p_r_e_v_i_o_u_s_ | │ │ │ │ * _i_m_e_x_a_m_ _v_0_._9_._1 » │ │ │ │ * _i_m_e_x_a_m_._c_o_n_n_e_c_t_ _M_o_d_u_l_e » │ │ │ │ * Imexamine │ │ │ │ ************ IImmeexxaammiinnee_?¶ ************ │ │ │ │ ccllaassss imexam.imexamine.Imexamine_[_s_o_u_r_c_e_]_¶ │ │ │ │ - Bases: _o_b_j_e_c_t │ │ │ │ + Bases: object │ │ │ │ The imexamine class controls plotting and analysis functions. │ │ │ │ do imexamine like routines on the current frame. │ │ │ │ read the returned cursor key value to decide what to do │ │ │ │ region_size is the default radius or side of the square for stat info │ │ │ │ Methods Summary │ │ │ │ _a_p_e_r___p_h_o_t(x, y Perform aperture photometry. │ │ │ │ [, data, genplot, fig, error]) │ │ │ │ @@ -90,18 +90,18 @@ │ │ │ │ _u_n_l_e_a_r_n___a_l_l() reset the default parameters for all │ │ │ │ functions. │ │ │ │ Methods Documentation │ │ │ │ aper_phot(xx, yy, ddaattaa==NNoonnee, ggeennpplloott==TTrruuee, ffiigg==NNoonnee, eerrrroorr==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Perform aperture photometry. │ │ │ │ Uses photutils functions, photutils must be available │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ - * ggeennpplloott (_bb_oo_oo_ll) – plot the apertures to a figure; if │ │ │ │ + * ggeennpplloott (bbooooll) – plot the apertures to a figure; if │ │ │ │ false then the tuple of (apertures, │ │ │ │ annulus_apertures,rawflux_table, sky_per_pix) is │ │ │ │ returned. │ │ │ │ * ffiigg (ffiigguurree oobbjjeecctt ffoorr rreeddiirreecctt) – Used for interaction │ │ │ │ with the ginga GUI │ │ │ │ * eerrrroorr (ffllooaatt aarrrraayy) – If error is not None, then it │ │ │ │ should be given the error array for the corresponding │ │ │ │ @@ -118,95 +118,95 @@ │ │ │ │ * WWhheerree aappeerrttuurreess aanndd aannnnuulluuss__aappeerrttuurreess aarree pphhoottuuiillss │ │ │ │ oobbjjeeccttss,, oorr NNoonnee │ │ │ │ close()_[_s_o_u_r_c_e_]_¶ │ │ │ │ For use with the Imexamine object standalone. │ │ │ │ column_fit(xx, yy, ddaattaa==NNoonnee, ffoorrmm==NNoonnee, ggeennpplloott==TTrruuee, ffiigg==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Compute the 1d fit to the column of data. │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ * ffoorrmm (ssttrriinngg) – This is the functional form specified │ │ │ │ in the column fit parameters │ │ │ │ - * ggeennpplloott (_ii_nn_tt) – produce the plot or return the fit │ │ │ │ + * ggeennpplloott (iinntt) – produce the plot or return the fit │ │ │ │ model │ │ │ │ * ffiigg (ffiigguurree nnaammee ffoorr rreeddiirreecctt) – Used for interaction │ │ │ │ with the ginga GUI │ │ │ │ Notes │ │ │ │ delta is the range of data values to use around the x,y location │ │ │ │ The background is currently ignored │ │ │ │ if centering is True, then the center is fit with a 2d gaussian, │ │ │ │ but this is currently not done for Polynomial1D │ │ │ │ com_center(xx, yy, ddaattaa==NNoonnee, ddeellttaa==NNoonnee, oovveerrssaammpplliinngg==11..00)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Return the center of mass of the object at x,y │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ - * ddeellttaa (_ii_nn_tt) – The range of data values (bounding box) │ │ │ │ + * ddeellttaa (iinntt) – The range of data values (bounding box) │ │ │ │ to use around the x,y location for calculating the │ │ │ │ center │ │ │ │ - * oovveerrssaammpplliinngg (_ii_nn_tt) – Oversampling factors of pixel │ │ │ │ + * oovveerrssaammpplliinngg (iinntt) – Oversampling factors of pixel │ │ │ │ indices. If oversampling is a scalar this is treated as │ │ │ │ both x and y directions having the same oversampling │ │ │ │ factor; otherwise it is treated as (x_oversamp, │ │ │ │ y_oversamp) │ │ │ │ contour(xx, yy, ddaattaa==NNoonnee, ffiigg==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ plot contours in a region around the specified location. │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ * ffiigg (ffiigguurree ffoorr rreeddiirreecctt) – Used for interaction with │ │ │ │ the ginga GUI │ │ │ │ curve_of_growth(xx, yy, ddaattaa==NNoonnee, ggeennpplloott==TTrruuee, ffiigg==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Display a curve of growth plot. │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ * ffiigg (ffiigguurree nnaammee ffoorr rreeddiirreecctt) – Used for interaction │ │ │ │ with the ginga GUI │ │ │ │ Notes │ │ │ │ the object photometry is taken from photutils │ │ │ │ cutout(xx, yy, ddaattaa==NNoonnee, ssiizzee==NNoonnee, ffiigg==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Make a fits cutout around the pointer location without wcs. │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ - * ssiizzee (_ii_nn_tt) – The radius of the cutout region │ │ │ │ + * ssiizzee (iinntt) – The radius of the cutout region │ │ │ │ * ffiigg (ffiigguurree ffoorr rreeddiirreecctt) – Used for interaction with │ │ │ │ the ginga GUI │ │ │ │ do_option(xx, yy, kkeeyy)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Run the imexam option. │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the cursor or data point │ │ │ │ - * yy (_ii_nn_tt) – The y location of the cursor or data point │ │ │ │ + * xx (iinntt) – The x location of the cursor or data point │ │ │ │ + * yy (iinntt) – The y location of the cursor or data point │ │ │ │ * kkeeyy (ssttrriinngg) – The key which was pressed │ │ │ │ gauss_center(xx, yy, ddaattaa==NNoonnee, ddeellttaa==1100, ssiiggmmaa__ffaaccttoorr==00)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Return the Gaussian 2D fit center of the object at (x,y). │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ - * ddeellttaa (_ii_nn_tt) – The range of data values (bounding box) │ │ │ │ + * ddeellttaa (iinntt) – The range of data values (bounding box) │ │ │ │ to use around the x,y location for calculating the │ │ │ │ center │ │ │ │ - * ssiiggmmaa__ffaaccttoorr (_ff_ll_oo_aa_tt,, ooppttiioonnaall) – The sigma clipping │ │ │ │ + * ssiiggmmaa__ffaaccttoorr (ffllooaatt,, ooppttiioonnaall) – The sigma clipping │ │ │ │ factor to use on the data fit │ │ │ │ get_options()_[_s_o_u_r_c_e_]_¶ │ │ │ │ Return the imexam options as a key list. │ │ │ │ get_plot_name()_[_s_o_u_r_c_e_]_¶ │ │ │ │ return the default plot name. │ │ │ │ histogram(xx, yy, ddaattaa==NNoonnee, ggeennpplloott==TTrruuee, ffiigg==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Calulate a histogram of the data values. │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt,, rreeqquuiirreedd) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt,, rreeqquuiirreedd) – The y location of the object │ │ │ │ + * xx (iinntt,, rreeqquuiirreedd) – The x location of the object │ │ │ │ + * yy (iinntt,, rreeqquuiirreedd) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy,, ooppttiioonnaall) – The data array to work │ │ │ │ on │ │ │ │ * ggeennpplloott (bboooolleeaann,, ooppttiioonnaall) – If false, returns the │ │ │ │ hist, bin_edges tuple │ │ │ │ * ffiigg (ffiigguurree nnaammee ffoorr rreeddiirreecctt) – Used for interaction │ │ │ │ with the ginga GUI │ │ │ │ Notes │ │ │ │ @@ -215,23 +215,23 @@ │ │ │ │ this was changed to the numpy histogram, with a subsequent plot if │ │ │ │ genplot is True. │ │ │ │ Does not yet support numpy v1.11 strings for bin estimation. │ │ │ │ line_fit(xx, yy, ddaattaa==NNoonnee, ffoorrmm==NNoonnee, ggeennpplloott==TTrruuee, ffiigg==NNoonnee, ccooll==FFaallssee) │ │ │ │ _[_s_o_u_r_c_e_]_¶ │ │ │ │ compute the 1D fit to the line of data using the specified form. │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ * ffoorrmm (ssttrriinngg) – This is the functional form specified │ │ │ │ in the line fit parameters see show_fit_models() │ │ │ │ - * ggeennpplloott (_bb_oo_oo_ll) – produce the plot or return the fit │ │ │ │ + * ggeennpplloott (bbooooll) – produce the plot or return the fit │ │ │ │ * ffiigg (ffiigguurree ffoorr rreeddiirreecctt) – Used for interaction with │ │ │ │ the ginga GUI │ │ │ │ - * ccooll (_bb_oo_oo_ll ((FFaallssee))) – Plot column instead of line │ │ │ │ + * ccooll (bbooooll ((FFaallssee))) – Plot column instead of line │ │ │ │ Notes │ │ │ │ The background is currently ignored │ │ │ │ If centering is True in the parameter set, then the center is fit │ │ │ │ with a 2d gaussian, not performed for Polynomial1D │ │ │ │ new_plot_window(xx, yy, ddaattaa==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ make the next plot in a new plot window. │ │ │ │ Notes │ │ │ │ @@ -240,29 +240,29 @@ │ │ │ │ general? Once the new plotting window is open all plots will be │ │ │ │ directed towards it. The old window cannot be used again. │ │ │ │ option_descrip(kkeeyy, ffiieelldd==11)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Return the looked up dictionary of options. │ │ │ │ Parameters: │ │ │ │ * kkeeyy (ssttrriinngg) – The key which was pressed, it relates to │ │ │ │ the function to call │ │ │ │ - * ffiieelldd (_ii_nn_tt) – This tells where in the option dictionary │ │ │ │ + * ffiieelldd (iinntt) – This tells where in the option dictionary │ │ │ │ the function name can be found │ │ │ │ plot_column(xx, yy, ddaattaa==NNoonnee, ffiigg==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ column plot of data at point y. │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ * ffiigg (ffiigguurree nnaammee ffoorr rreeddiirreecctt) – Used for interaction │ │ │ │ with the ginga GUI │ │ │ │ plot_line(xx, yy, ddaattaa==NNoonnee, ffiigg==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ line plot of data at point x. │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ * ffiigg (ffiigguurree oobbjjeecctt ffoorr rreeddiirreecctt) – Used for interaction │ │ │ │ with the ginga GUI │ │ │ │ print_options()_[_s_o_u_r_c_e_]_¶ │ │ │ │ Print the imexam options to screen. │ │ │ │ radial_profile(xx, yy, ddaattaa==NNoonnee, ffoorrmm==NNoonnee, ggeennpplloott==TTrruuee, ffiigg==NNoonnee) │ │ │ │ _[_s_o_u_r_c_e_]_¶ │ │ │ │ @@ -270,36 +270,36 @@ │ │ │ │ object. │ │ │ │ From the parameters Dictionary: If pixel is True, then every pixel │ │ │ │ at each radius is plotted. If pixel is False, then the sum of all │ │ │ │ pixels in integer bins is plotted │ │ │ │ Background may be subtracted and centering can be done with a 2D │ │ │ │ Gaussian fit. These options are read from the plot parameters dict. │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ * ffoorrmm (ssttrriinngg) – The string name of the form of the fit │ │ │ │ to use │ │ │ │ - * ggeennpplloott (_bb_oo_oo_ll) – Generate the plot if True, else │ │ │ │ + * ggeennpplloott (bbooooll) – Generate the plot if True, else │ │ │ │ retfurn the fit data │ │ │ │ register(uusseerr__ffuunnccss)_[_s_o_u_r_c_e_]_¶ │ │ │ │ register a new imexamine function made by the user as an option. │ │ │ │ Parameters: │ │ │ │ - uusseerr__ffuunnccss (_dd_ii_cc_tt) – Contains a dictionary where each key is │ │ │ │ + uusseerr__ffuunnccss (ddiicctt) – Contains a dictionary where each key is │ │ │ │ the binding for the (function,description) tuple │ │ │ │ Notes │ │ │ │ The new binding will be added to the dictionary of imexamine │ │ │ │ functions as long as the key is unique. The new functions do not │ │ │ │ have to have default dictionaries associated with them. │ │ │ │ report_stat(xx, yy, ddaattaa==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ report the statisic of values in a box with side region_size. │ │ │ │ The statistic can be any numpy function │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ reset_defpars()_[_s_o_u_r_c_e_]_¶ │ │ │ │ set all pars to their defaults. │ │ │ │ save(ffiilleennaammee==NNoonnee, ffiigg==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Save to file the figure that’s currently displayed. │ │ │ │ this is used for the standalone plotting │ │ │ │ Parameters: │ │ │ │ @@ -354,34 +354,34 @@ │ │ │ │ set_radial_pars()_[_s_o_u_r_c_e_]_¶ │ │ │ │ set parameters for radial profile plots. │ │ │ │ set_surface_pars()_[_s_o_u_r_c_e_]_¶ │ │ │ │ set parameters for surface plots. │ │ │ │ setlog(ffiilleennaammee==NNoonnee, oonn==TTrruuee, lleevveell==2200)_[_s_o_u_r_c_e_]_¶ │ │ │ │ Turn on and off logging to a logfile or the screen. │ │ │ │ Parameters: │ │ │ │ - * ffiilleennaammee (_ss_tt_rr,, ooppttiioonnaall) – Name of the output file to │ │ │ │ + * ffiilleennaammee (ssttrr,, ooppttiioonnaall) – Name of the output file to │ │ │ │ record log information │ │ │ │ - * oonn (_bb_oo_oo_ll,, ooppttiioonnaall) – True by default, turn the logging │ │ │ │ + * oonn (bbooooll,, ooppttiioonnaall) – True by default, turn the logging │ │ │ │ on or off │ │ │ │ * lleevveell (llooggggiinngg ccllaassss,, ooppttiioonnaall) – set the level for │ │ │ │ logging messages, turn off screen messages by setting │ │ │ │ to logging.CRITICAL │ │ │ │ show_fit_models()_[_s_o_u_r_c_e_]_¶ │ │ │ │ Print the available astropy models for plot fits. │ │ │ │ show_xy_coords(xx, yy, ddaattaa==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ print the x,y,value to the screen. │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ surface(xx, yy, ddaattaa==NNoonnee, ffiigg==NNoonnee)_[_s_o_u_r_c_e_]_¶ │ │ │ │ plot a surface around the specified location. │ │ │ │ Parameters: │ │ │ │ - * xx (_ii_nn_tt) – The x location of the object │ │ │ │ - * yy (_ii_nn_tt) – The y location of the object │ │ │ │ + * xx (iinntt) – The x location of the object │ │ │ │ + * yy (iinntt) – The y location of the object │ │ │ │ * ddaattaa (nnuummppyy aarrrraayy) – The data array to work on │ │ │ │ * ffiigg (ffiigguurree ffoorr rreeddiirreecctt) – Used for interaction with │ │ │ │ the ginga GUI │ │ │ │ unlearn_all()_[_s_o_u_r_c_e_]_¶ │ │ │ │ reset the default parameters for all functions. │ │ │ │ _[_L_o_g_o_] │ │ │ │ ******** PPaaggee CCoonntteennttss ********