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
│ │ │ @@ -682,15 +682,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 │ │ │ @@ -706,16 +706,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
│ │ │
│ │ │
│ │ │ │ │ ││ │ │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
│ │ │ │ │ │
-
│ │ │
-
│ │ │
path
¶
│ │ │ @@ -192,15 +192,15 @@
│ │ │ 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)
│ │ │ │ │ │
_ext
¶ │ │ │-
│ │ │
-
│ │ │
_extname
¶
│ │ │ @@ -216,15 +216,15 @@
│ │ │ -
│ │ │
_extver
¶
│ │ │ If available, the EXTVER of the MEF extension that is loaded, taken │ │ │ from the current data header
│ │ │ │ │ │-
│ │ │
_ds9_process
¶
│ │ │ @@ -262,27 +262,27 @@
│ │ │
│ │ │ -
│ │ │
_numaxis
¶
│ │ │ number of image planes, this is NAXIS
│ │ │ │ │ │-
│ │ │
_naxis
¶
│ │ │ specific image plane displayed, defaulted to 1 image plane, most │ │ │ relevant to cube fits files
│ │ │ │ │ │-
│ │ │
blink
(blink=True, interval=None)[source]¶
│ │ │ 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 │ │ │ @@ -519,42 +519,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.
│ │ │ │ │ │
-
│ │ │
-
│ │ │
contour
(on=True, construct=True)[source]¶
│ │ │ show contours on the window.
│ │ │-
│ │ │
- Parameters │ │ │
- │ │ │ │ │ │
-
│ │ │
-
│ │ │ @@ -571,24 +571,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
│ │ │
│ │ │
-
│ │ │
- │ │ │ @@ -596,16 +596,16 @@ │ │ │
move the cursor in the current frame to the specified image pixel.
│ │ ││ │ │
│ │ │selected regions will also be moved
│ │ │-
│ │ │
- Parameters │ │ │
- │ │ │ │ │ │
-
│ │ │ @@ -622,15 +622,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
│ │ │ @@ -727,16 +727,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
│ │ │
│ │ │
- │ │ │ @@ -757,16 +757,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
│ │ │
│ │ │ 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
│ │ │- Parameters │ │ │
-
│ │ │
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
│ │ │
│ │ │ -
│ │ │
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.
│ │ │ @@ -900,16 +900,16 @@ │ │ │-
│ │ │
-
│ │ │
panto_image
(x, y)[source]¶
│ │ │ convenience function to change to x,y physical image coordinates.
│ │ │ │ │ │
-
│ │ │
-
│ │ │ @@ -945,17 +945,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
│ │ │
│ │ │
-
│ │ │
- │ │ │ @@ -1047,36 +1047,36 @@ │ │ │ │ │ │
-
│ │ │
showpix
(close=False)[source]¶
│ │ │ display the pixel value table, close window when done.
│ │ │ │ │ │-
│ │ │
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
│ │ │
│ │ │
-
│ │ ├── ./usr/share/doc/python-imexam-doc/html/api/imexam.ginga_viewer.ginga.html
│ │ │ @@ -91,19 +91,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.
│ │ │
│ │ │ -
│ │ │ 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.
│ │ │ @@ -106,19 +106,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
│ │ │ @@ -294,16 +294,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
│ │ │
│ │ │
-
│ │ │ @@ -423,15 +423,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
│ │ │
-
│ │ │
- │ │ │ @@ -524,15 +524,15 @@ │ │ │
-
│ │ │
rotate
(value=None)[source]¶
│ │ │ Rotate the current frame (in degrees).
│ │ │the current rotation is printed with no params
│ │ │ │ │ │-
│ │ ├── ./usr/share/doc/python-imexam-doc/html/api/imexam.imexamine.Imexamine.html
│ │ │ @@ -75,15 +75,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
│ │ ││ │ │
│ │ │ @@ -230,18 +230,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 │ │ │ @@ -271,19 +271,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
│ │ │ @@ -294,20 +294,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)
│ │ │
│ │ │
-
│ │ │
-
│ │ │
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
│ │ │ @@ -349,52 +349,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 │ │ │
- │ │ │ │ │ │
-
│ │ │
-
│ │ │
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
│ │ │
│ │ │
-
│ │ │
- │ │ │ @@ -411,16 +411,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
│ │ │ @@ -434,22 +434,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
│ │ │ @@ -470,46 +470,46 @@ │ │ │-
│ │ │
option_descrip
(key, field=1)[source]¶
│ │ │ Return the looked up dictionary of options.
│ │ │-
│ │ │
- Parameters │ │ │
- │ │ │ │ │ │
-
│ │ │
-
│ │ │
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
│ │ │
│ │ │
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.
│ │ │ @@ -561,16 +561,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
│ │ │ │ │ │-
│ │ │
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
│ │ │
│ │ │
-
│ │ │
show_xy_coords
(x, y, data=None)[source]¶
│ │ │ print the x,y,value to the screen.
│ │ │ │ │ │-
│ │ │
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
│ │ │
│ │ │
-
│ │ │
-
│ │ │
-
│ │ │ @@ -715,16 +715,16 @@
│ │ │
-
│ │ │
-
│ │ │
-
│ │ │
-
│ │ │
-
│ │ │ class
-
│ │ │
-
│ │ │
-
│ │ │
-
│ │ │
-
│ │ │
-
│ │ │
Methods Summary
│ │ ├── ./usr/share/doc/python-imexam-doc/html/api/imexam.ginga_viewer.ginga_general.html │ │ │ @@ -69,15 +69,15 @@ │ │ ││ │ │ │ │ ││ │ │ginga_general¶
│ │ │-
│ │ │
-
│ │ │
-
│ │ │
-
│ │ │
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}”
│ │ │ @@ -807,35 +807,35 @@ │ │ │-
│ │ │
│ │ │a convienence function, you can also use set_region
│ │ │-
│ │ │
Notes
│ │ │only circular regions are supported currently
│ │ │ @@ -865,22 +865,22 @@ │ │ │
-
│ │ │
-
│ │ │
-
│ │ │
-
│ │ │
starter.
│ │ │Notes
│ │ │I think this is a quirk in the XPA communication. The xpans, and XPA │ │ │ @@ -469,28 +469,28 @@ │ │ │
Methods Documentation
│ │ │ │ │ │ │ │ │-
│ │ │