Plot_Fits

Generated by IDLdoc

summary     class     fields     routine details     file attributes

./

plot_fits.pro

topPlot_Fits

Plot_Fits [, image_in] [, header_in] [, AxisColor= 'string'] [, BackColor= 'string'] [, BarTitle= 'string'], Block=Block [, Brightness= 'float'] [, C_Annotation= 'string'] [, C_Charsize= 'float'] [, C_Colors= 'string'] [, C_Labels= 'integer'] [, C_Linestyle= 'integer'] [, C_Thick= 'integer'] [, Charsize= 'float'] [, Charthick= 'float'] [, Clip= 'float'] [, ColorTable= 'integer'] [, Contrast= 'float'] [, Contours= 'integer'] [, Deltavel= 'float'] [, Downhill= 'integer'] [, Filename= 'string'] [, Font= 'integer'] [, HighScale= 'float'] [, Invert= 'integer'] [, Levels= 'float'] [, Limits= 'float'] [, LowScale= 'float'] [, Max_value= 'float'] [, Mask= 'integer'] [, Min_value= 'float'] [, Minor= 'integer'] [, NLevels= 'integer'] [, NoAxis= 'integer'] [, NoBar= 'integer'] [, NoGUI= 'integer'] [, Obj= 'object reference'] [, OutFile= 'string'] [, Position= 'float'] [, Quit= 'integer'] [, RegionFile= 'string'] [, Reverse= 'integer'] [, Scale_To_Image= 'integer'] [, Scaling= 'string'] [, Sexadecimal= 'integer'] [, Subtitle= 'string'] [, TickColor= 'string'] [, Ticklen= 'float'] [, Ticks= 'float'] [, Title= 'string'] [, tlbid= 'integer'] [, Velocity= 'float'] [, Wid= 'integer'] [, XTitle= 'string'] [, YTitle= 'string']

Display and analysis of images and data cubes.

Parameters

image_in in optional type= 'float'

A data array, a fits file name, OR an array of filenames

header_in in optional type= 'string'

A string array prepresenting the header of the loaded array. Ignored if a filename is input.

Keywords

AxisColor in optional type= 'string'

The axis color.

BackColor in optional type= 'string'

The background color.

BarTitle in optional type= 'string'

Colorbar title Block : in, optional, type = 'integer' Set to block the command line.

Block
Brightness in optional type= 'float'

Brightness (stretch)

C_Annotation in optional type= 'string'

Contour annotations

C_Charsize in optional type= 'float'

Contour annotation character size

C_Colors in optional type= 'string'

Contour colors

C_Labels in optional type= 'integer'

Contour labels (binary array)

C_Linestyle in optional type= 'integer'

Contour line styles (solid, dashed, etc)

C_Thick in optional type= 'integer'

Contour thickness

Charsize in optional type= 'float'

Character size for axes

Charthick in optional type= 'float'

Character thickness for axes

Clip in optional type= 'float'

The percent to clip the image at using histogram clipping

ColorTable in optional type= 'integer'

The colortable index to load

Contrast in optional type= 'float'

Contrast (level)

Contours in optional type= 'integer'

Binary array for which image should be displayed with contours

Deltavel in optional type= 'float'

Range to intergated the velocity over

Downhill in optional type= 'integer'

Downhill contours

Filename in optional type= 'string'

Output file name

Font in optional type= 'integer'

The axes font

HighScale in optional type= 'float'

The highest value to plot

Invert in optional type= 'integer'

Invert the color table

Levels in optional type= 'float'

Contour levels

Limits in optional type= 'float'

Data limits: [xmin, xmax, ymin, ymax]

LowScale in optional type= 'float'

The lowest value to plot

Max_value in optional type= 'float'

Max value for contours - used with nlevels keyword

Mask in optional type= 'integer'

Output mask

Min_value in optional type= 'float'

Max value for contours - used with nlevels keyword

Minor in optional type= 'integer'

Minor tick marks

NLevels in optional type= 'integer'

Number of contour levels

NoAxis in optional type= 'integer'

Don't plot the axis

NoBar in optional type= 'integer'

Don't plot the color bar

NoGUI in optional type= 'integer'

Set this keyword to prevent the GUI display from being shown.

Obj out optional type= 'object reference'

This output is for the object reference so further command line processing may be implemented.

OutFile in optional type= 'string'

Image output file. Can be jpg, ps, gif, etc. This is a scaler

Position in optional type= 'float'

The position of the plot in the window

Quit in optional type= 'integer'

Quit after loaded - good for immediate output of ps files

RegionFile in optional type= 'string'

Region file to load

Reverse in optional type= 'integer'

Set this keyword to reverse the color table.

Scale_To_Image in optional type= 'integer'

Will scale the image based on the min and max of the current image displayed

Scaling in optional type= 'string'

Which type of scaling to use

Sexadecimal in optional type= 'integer'

Sexadecimal numbers on axes

Subtitle in optional type= 'string'

Subtitle

TickColor in optional type= 'string'

Tickmark color

Ticklen in optional type= 'float'

The length of the tickmarks. 0.02 is the default and 1 draws a grid

Ticks in optional type= 'float'

Major tick marks

Title in optional type= 'string'

Title printed above plot

tlbid out optional type= 'integer'

Outputs the widget ID of the program. Useful for getting information out if necessary.

Velocity in optional type= 'float'

The velocity of the 3-D image to display

Wid out optional type= 'integer'

This is an output variable for the main draw window ID

XTitle in optional type= 'string'

The X-Axis title

YTitle in optional type= 'string'

The Y-Axis title

Examples

The most simple call will simply bring up the GUI display: IDL> plot_fits Load an image and set some basic parameters. Let's change the colortable to black and white, scale the display to the image value range, and zoom in on a region of interest using the limits keyword: IDL> plot_fits, 'file1.fits', colortable = 0, /scale_to_image, limits = [40.5, 40.8, -0.3, 0.0] Let's load an array and header that we have already read in, load a region file, then create a postscript file: IDL> plot_fits, array ,hdr, regionfile = 'regions.reg', outfile = 'image.ps' Let's load a couple images, put contours on the first one and apply some scaling. Inputs now must be arrays: IDL> plot_fits, ['file1.fits', 'file2.fits'], contours = [1, 0], lowscale = [0, 30], highscale = [100, 40] Finally, let's just create the plot_fits object and get its object reference for further command line processing: IDL> plot_fits, obj = obj, /nogui

Author information

History:

Written by Loren D. Anderson. V1.0 beta release November 2007 V2.0 beta release June 2008

File attributes

Modifcation date: Tue May 27 11:48:52 2008
Lines: 269
Docformat: rst rst