topPlot_Fits::Align

Plot_Fits::Align, image

Parameters

image in required type=integer

The image index to align to.

Examples

topPlot_Fits::Axis

Plot_Fits::Axis [, default_titles= 'integer'] [, clear_titles= 'integer'] [, noaxis= 'integer'] [, nobar= 'integer'] [, title= 'string'] [, xtitle= 'string'] [, ytitle= 'string'] [, bartitle= 'string'] [, subtitle= 'string'] [, charsize= 'float'] [, charthick= 'float'] [, minor= 'integer'] [, ticklen= 'float'] [, ticks= 'integer'] [, font= 'integer'] [, axiscolor= 'string'] [, backcolor= 'string'] [, tickcolor= 'string'] [, noplot= 'integer']

Keywords

apply in optional private type= 'integer'

Apply changes to GUI

default_titles in optional type= 'integer'

Set this keyword to plot the default axis titles

clear_titles in optional type= 'integer'

Set this keyword to clear the axis titles

noaxis in optional type= 'integer'

Set this keyword to remove the axis titles

nobar in optional type= 'integer'

Set this keyword to remove the colorbar

title in optional type= 'string'

Set this to a string for the title

xtitle in optional type= 'string'

Set this to a string for the x-axis

ytitle in optional type= 'string'

Set this to a string for the y-axis

bartitle in optional type= 'string'

Set this to a string for the colorbar title

subtitle in optional type= 'string'

Set this to a string for the subtitle

charsize in optional type= 'float'

The size of the axis characters

charthick in optional type= 'float'

The thickness of the axis characters

minor in optional type= 'integer'

The spacing of the minor tickmarks

ticklen in optional type= 'float'

The length of the tickmarks

ticks in optional type= 'integer'

The spacing of the tick marks

font in optional type= 'integer'

The font type to use

axiscolor in optional type= 'string'

The colr of the axis and titles

backcolor in optional type= 'string'

The color of the background

tickcolor in optional type= 'string'

The color of the tickmarks

noplot in optional type= 'integer'

Set this keyword to not update the plot when changes are made.

topPlot_Fits::Change_Image

Plot_Fits::Change_Image, newimage [, noplot= 'integer']

Parameters

newimage in required type= 'integer'

The image index to change to.

Keywords

noplot in optional type= 'integer'

Don't redraw the graphics after changing the image.

topPlot_Fits::Colors

Plot_Fits::Colors [, colorTable= 'integer'] [, invert= 'integer'] [, reverse= 'integer']

Keywords

colorTable in optional type= 'integer'

The colortable number to switch to.

invert in optional type= 'integer'

Invert the current color table

reverse in optional type= 'integer'

reverse the current color table

topPlot_Fits::Contour

Plot_Fits::Contour [, whichimage], Apply=Apply [, On= 'integer'] [, Off= 'integer'] [, Toggle= 'integer'], NoPlot=NoPlot [, C_Annotation= 'string'] [, C_Charsize= 'float'] [, C_Charthick= 'float'] [, C_Colors= 'string'] [, C_Labels= 'integer'] [, C_Linestyle= 'integer'] [, C_Thick= 'float'], S_Annotation=S_Annotation, S_Charsize=S_Charsize, S_Charthick=S_Charthick, S_Colors=S_Colors, S_Labels=S_Labels, S_Levels=S_Levels, S_Linestyle=S_Linestyle, S_Thick=S_Thick [, Downhill= 'integer'] [, Levels= 'float'] [, NLevels= 'integer'] [, Max_Value= 'float'] [, Min_Value= 'float'] [, percent= 'integer']

Parameters

whichimage in optional type= 'integer'

The image to apply the keywords to.

Keywords

Apply

On in optional type= 'integer'

Turn contours on for the image

Off in optional type= 'integer'

Turn contours off for the image

Toggle in optional type= 'integer'

Toggle the contours on and off for the image

NoPlot

C_Annotation in optional type= 'string'

Annotation for each contour level

C_Charsize in optional type= 'float'

Character size for the contour annotations

C_Charthick in optional type= 'float'

Character thickness for the contour annotations

C_Colors in optional type= 'string'

Colors for each contour level

C_Labels in optional type= 'integer'

Binary for each level for which ones are to be labeled

C_Linestyle in optional type= 'integer'

Linestyle for each contour level

C_Thick in optional type= 'float'

Thickness for each contour level

S_Annotation

S_Charsize

S_Charthick

S_Colors

S_Labels

S_Levels

S_Linestyle

S_Thick

Downhill in optional type= 'integer'

Binary for whether to draw downhill tickmarks

Levels in optional type= 'float'

Contour levels

NLevels in optional type= 'integer'

Number of levels. Scaled from min_value to max_value

Max_Value in optional type= 'float'

Maximum scaled value for nlevels. Defaults to scaled max.

Min_Value in optional type= 'float'

Minimum scaled value for nlevels. Defaults to scaled min.

percent in optional type= 'integer'

Set to 1 if leves are to be drawn evenly from min_value to max_value, 0 if they are to be drawn from the values in levels. noplot : in, optional, type = 'integer' Set this keyword to not update the plot when changes are made.

topPlot_Fits::Coordinates

Plot_Fits::Coordinates [, coordType] [, Degrees= 'integer'] [, Sexadecimal= 'integer']

Parameters

coordType in optional type= 'string'

The new coordinate type to change to. Possible values are 'Galactic', 'J2000', 'B1950', 'Ecliptic', 'Image'

Keywords

Degrees in optional type= 'integer'

Set this keyword to plot the axis values in degrees

Sexadecimal in optional type= 'integer'

Set this keyword to plot the axis values in sexadecimal format

topPlot_Fits::Delete

Plot_Fits::Delete [, whichDelete] [, All= 'integer']

Parameters

whichDelete in optional type= 'integer'

The image to delete

Keywords

All in optional type= 'integer'

Set this keyword to delete all the images

topPlot_Fits::GetProperty

Plot_Fits::GetProperty, autoupdate=autoupdate, header=header, filenames=filenames, selected=selected, n_regions=n_regions, limits=limits, pix_limits=pix_limits, region_xrange=region_xrange, region_yrange=region_yrange, lowscale=lowscale, highscale=highscale

Keywords

autoupdate

header

filenames

selected

n_regions

limits

pix_limits

region_xrange

region_yrange

lowscale

highscale

topPlot_Fits::Limits

Plot_Fits::Limits, xmin, xmax, ymin, ymax [, pixel= 'integer']

Parameters

xmin in required type= 'float'

Minimum x-axis value

xmax in required type= 'float'

Maximum x-axis value

ymin in required type= 'float'

Minimum y-axis value

ymax in required type= 'float'

Maximum y-axis value

Keywords

pixel in optional type= 'integer'

Set this keyword to interpret the limits as pixel values

topPlot_Fits::Load

Plot_Fits::Load, image, header, arrayname=arrayname, good_image=good_image, noplot=noplot

Parameters

image

header

Keywords

arrayname

good_image

noplot

topPlot_Fits::Save

Plot_Fits::Save [, filename] [, Fits= 'integer'] [, Gif= 'integer'] [, IDL_Variable= 'integer'] [, Jpg= 'integer'] [, Jpeg= 'integer'] [, Png= 'integer'] [, Pict= 'integer'] [, PS= 'integer'] [, Tiff= 'integer'] [, system_variable= 'integer'], _Extra=_Extra

Parameters

filename in optional type= 'string'

The output filename.

Keywords

Fits in optional type= 'integer'

Set this keyword to output a fits subset image

Gif in optional type= 'integer'

Set this keyword to output a gif image

IDL_Variable in optional type= 'integer'

Set this keyword to output an IDL variable

Jpg in optional type= 'integer'

Set this keyword to output a jpg image

Jpeg in optional type= 'integer'

Set this keyword to output a jpg image

Png in optional type= 'integer'

Set this keyword to output a png image

Pict in optional type= 'integer'

Set this keyword to output a pict image

PS in optional type= 'integer'

Set this keyword to output a postscript file

Tiff in optional type= 'integer'

Set this keyword to output a tiff image

system_variable in optional type= 'integer'

Set this keyword to output a system variable

_Extra

topPlot_Fits::Stretch

Plot_Fits::Stretch [, brightness= 'float'] [, contrast= 'float'] [, reset= 'integer'] [, nocontours= 'integer']

Keywords

brightness in optional type= 'float'

Value from 0 to 1 for brightness

contrast in optional type= 'float'

Value from 0 to 1 for contrast

reset in optional type= 'integer'

Reset the values to their defaults (0.5 and 0.5)

noSliderUpdate in optional private type= 'integer'

Don't change the slider positions

nocontours in optional type= 'integer'

Don't replot the contours. Useful if changing rapidly over many values.

topPlot_Fits::Scale

Plot_Fits::Scale [, lowscale] [, highscale] [, percent= 'float'] [, Scale_to_Image= 'integer'], noupdate=noupdate [, linear= 'integer'] [, log= 'integer'] [, histeq= 'integer'] [, asinh= 'integer'] [, squared= 'integer'] [, squareroot= 'integer']

Parameters

lowscale in optional type= 'float'

The low scaling value

highscale in optional type= 'float'

The high scaling value

Keywords

percent in optional type= 'float'

Implement histogram clipping. If the scale_to_image keyword is set, this is implemented over the min and max of the displayed image.

Scale_to_Image in optional type= 'integer'

Scale to the min and max of the displayed image.

noupdate

linear in optional type= 'integer'

Use a linear scale

log in optional type= 'integer'

Use a logarithmic scale

histeq in optional type= 'integer'

Use a histogram equalization scale

asinh in optional type= 'integer'

Use a asinh scale

squared in optional type= 'integer'

Use a squared scale

squareroot in optional type= 'integer'

Use a square root scale

topPlot_Fits::Velocity

Plot_Fits::Velocity [, velocity] [, velocity2] [, whichImage= 'integer'] [, deltavel= 'float'] [, pixel= 'integer'], noSliderUpdate=noSliderUpdate

Parameters

velocity in optional type= 'float'

The velocity to change to.

velocity2 in optional type= 'float'

If non-zero, the image will be created from the range of velocity to velocity2.

Keywords

whichImage in optional type= 'integer'

Which image this applies to

deltavel in optional type= 'float'

The width of velocities to smooth over

pixel in optional type= 'integer'

Set this keyword to intepret the input in pixels instead of coordinates

noSliderUpdate

topPlot_Fits::Zoom

Plot_Fits::Zoom [, xcenter] [, ycenter] [, factor= 'float'] [, cursor= 'integer']

Parameters

xcenter in optional type= 'float'

X center to zoom into

ycenter in optional type= 'float'

Y center to zoom into

Keywords

factor in optional type= 'float'

Zooming factor. Less than 1 for zooming in. Greater than 1 for zooming out.

cursor in optional type= 'integer'

If set, the cursor position will not be updated.

topPlot_Fits::Spectrum

Plot_Fits::Spectrum [, axiscolor= 'string'] [, backcolor= 'string'], charsize=charsize, charthick=charthick [, color= 'string'], linestyle=linestyle, width=width, xrange=xrange, yrange=yrange

Keywords

axiscolor in optional type= 'string'

The axis color name

backcolor in optional type= 'string'

The background color name

charsize

The size of the axis characters

charthick

The thickness of the axis characters

color in optional type= 'string'

The spectrum line color name

linestyle

The line style to use when plotting the spectrum

width

The width of the spectrum line

xrange

The xrange of the spectrum plot

yrange

The yrange of the spectrum plot

topPlot_Fits::ThreeD

Plot_Fits::ThreeD

topPlot_Fits::Threshold_Image

Plot_Fits::Threshold_Image [, threshold_low] [, threshold_high]

Parameters

threshold_low in optional

The low threshold value

threshold_high in optional

The high threshold value

topPlot_Fits::Copy

Plot_Fits::Copy

topPlot_Fits::Cut

Plot_Fits::Cut

topPlot_Fits::Paste

Plot_Fits::Paste

topPlot_Fits::Combine

Plot_Fits::Combine

topPlot_Fits::Dissolve

Plot_Fits::Dissolve

topPlot_Fits::ContainsPoints

result = Plot_Fits::ContainsPoints(x, y [, coords= 'string'] [, Count= 'integer'])

Return value

Parameters

x in required type= 'float'

The x position to test

y in required type= 'float'

The y position to test

Keywords

coords in optional type= 'string'

A string representing the coordinate system the x and y position is in. If unspecified, x and y are assumed to be in the current coordinate system.

Count out optional type= 'integer'

The number of regions that contain the specified point.

topPlot_Fits::Delete_Regions

Plot_Fits::Delete_Regions [, whichRegions] [, All= 'integer']

Parameters

whichRegions in optional type= 'integer'

The regions to delete specified as an integer array

Keywords

All in optional type= 'integer'

Set this keyword to delete all the regions

topPlot_Fits::GetStats

result = Plot_Fits::GetStats()

Return value

topPlot_Fits::Global_Region_Property

Plot_Fits::Global_Region_Property [, background= 'integer'] [, color= 'string'] [, include= 'integer'] [, exclude= 'integer'] [, linepar= 'integer'] [, linestyle= 'integer'] [, polygon= 'integer'] [, regionType= 'string'] [, source= 'integer'] [, width= 'integer']

Keywords

background in optional type= 'integer'

Set this keyword for background regions

color in optional type= 'string'

Set to a color string specified in colors.txt

include in optional type= 'integer'

Set this keyword for included regions

exclude in optional type= 'integer'

Set this keyword for excluded regions

linepar in optional type= 'integer'

Set this keyword for line regions where interior pixels are not counted in region statistics

linestyle in optional type= 'integer'

Set to desired linestyle

polygon in optional type= 'integer'

Set this keyword for polygon regions where interior pixels are counted in region statistics

regionType in optional type= 'string'

Set to have future regions drawn as this region type

source in optional type= 'integer'

Set this keyword for source regions

width in optional type= 'integer'

Set to desired display width

topPlot_Fits::Load_Regions

Plot_Fits::Load_Regions [, filename]

Parameters

filename in optional type= 'string'

Region file to load. If not present, a dialog will be brought up.

topPlot_Fits::Make_Region

Plot_Fits::Make_Region, regiontype, params [, background= 'integer'], coords=coords [, color= 'string'] [, exclude= 'integer'] [, include= 'integer'] [, linestyle= 'integer'] [, line= 'integer'], noplot=noplot [, polygon= 'integer'] [, source= 'integer'] [, width= 'integer']

Parameters

regiontype in required

The type of region to create.

params in required

The parameters for the region. The parameters are exactly the same as they appear in the region file.

Keywords

background in optional type= 'integer'

Set this keyword for background regions

coords

color in optional type= 'string'

Set to a color string specified in colors.txt coords : in, optional, type = 'string' The coordinate system to use.

exclude in optional type= 'integer'

Set this keyword for excluded regions

include in optional type= 'integer'

Set this keyword for included regions

linestyle in optional type= 'integer'

Set to desired linestyle

line in optional type= 'integer'

Set this keyword for line regions where interior pixels are not counted in region statistics

noplot

polygon in optional type= 'integer'

Set this keyword for polygon regions where interior pixels are counted in region statistics

source in optional type= 'integer'

Set this keyword for source regions

width in optional type= 'integer'

Set to desired display width

topPlot_Fits::Move_Region

Plot_Fits::Move_Region, direction

Parameters

direction in required type= 'string'

The direction [up, down, left or right] to move the region. I'll probably change this keyword in the future to something more sensible

topPlot_Fits::Plot_Histogram

Plot_Fits::Plot_Histogram [, _Extra=_Extra]

Keywords

_Extra in optional

Use this keyword to pass any additional plot parameters

topPlot_Fits::RegionProperty

Plot_Fits::RegionProperty [, background= 'integer'] [, color= 'string'] [, exclude= 'integer'] [, include= 'integer'] [, width= 'integer'] [, linepar= 'integer'] [, linestyle= 'integer'], name=name [, polygon= 'integer'] [, position= 'integer'] [, source= 'integer']

Keywords

background in optional type= 'integer'

Set this keyword for background regions

color in optional type= 'string'

Set to a color string specified in colors.txt

context in optional private type= 'integer'

Set to indicate that event generated from the context menu and therefore the changes should apply to the self.whichinside region only.

exclude in optional type= 'integer'

Set this keyword for excluded regions

include in optional type= 'integer'

Set this keyword for included regions

width in optional type= 'integer'

Set to desired display width

linepar in optional type= 'integer'

Set this keyword for line regions where interior pixels are not counted in region statistics.

linestyle in optional type= 'integer'

Set to desired linestyle

name

polygon in optional type= 'integer'

Set this keyword for polygon regions where interior pixels are counted in region statistics

position in optional type= 'integer'

An array of region indices to apply these changes to. Defaults to all selected regions.

source in optional type= 'integer'

Set this keyword for source regions

topPlot_Fits::Rotate_Region

Plot_Fits::Rotate_Region, angle

Parameters

angle in required

The new angle to rotate to in degrees.

topPlot_Fits::Save_Mask

Plot_Fits::Save_Mask [, filename]

Parameters

filename in optional type= 'string'

The name of the output FITS file. If not present, a dialog will be brought up.

Keywords

weighted in optional private type= 'integer'

If set, the mask values will be weighted by the fraction of each pixel that the region lies inside.

topPlot_Fits::Save_Regions

Plot_Fits::Save_Regions [, filename]

Parameters

filename in optional type= 'string'

The name of the output file. If not present, a dialog will be brought up.

topPlot_Fits::Select

Plot_Fits::Select [, positions] [, All= 'integer'] [, Background= 'integer'] [, Exclude= 'integer'] [, Invert= 'integer'] [, Last= 'integer'] [, None= 'integer'] [, Selected= 'integer'] [, Source= 'integer']

Parameters

positions in optional type= 'integer'

An array of region indices to select.

Keywords

All in optional type= 'integer'

Set this keyword to select all regions

Background in optional type= 'integer'

Set this keyword to select background regions

Exclude in optional type= 'integer'

Set this keyword to select excluded regions

Invert in optional type= 'integer'

Set this keyword to invert the current selection

Last in optional type= 'integer'

Set this keyword to select the last region in the region list

None in optional type= 'integer'

Set this keyword to de-select all regions

Selected out optional type= 'integer'

An array of the region indices that are selected

Source in optional type= 'integer'

Set this keyword to select source regions

topPlot_Fits::Zoom_Region

Plot_Fits::Zoom_Region

topPlot_Fits_Menubar_Zoom

Plot_Fits_Menubar_Zoom, event

Parameters

event

topPlot_Fits::GUI

Plot_Fits::GUI [, block= 'integer']

Keywords

block in optional type= 'integer'

If set, the commandline will be blocked. Very useful for multiple calls to the program since it can act like a "pause."

topPlot_Fits::NoGUI

Plot_Fits::NoGUI

topPlot_Fits::Init

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

Return value

Parameters

image_in in optional type= 'float OR string'

The image data. Can be an array or a filename.

header_in in optional type= 'string'

The header data.

Keywords

AxisColor

The axis color.

BackColor

The background color.

BarTitle

Colorbar title

Block

Blocks the command line

Brightness

Brightness (stretch)

C_Annotation

Contour annotations

C_Charsize

Contour annotation character size

C_Colors

Contour colors

C_Labels

Contour labels (binary array)

C_Linestyle

Contour line styles (solid, dashed, etc)

C_Thick

Contour thickness

Charsize

Character size for axes

Charthick

Character thickness for axes

Clip

The percentage at which to clip the input image

ColorTable

The colortable index to load

Contrast

Contrast (level)

Contours

Binary array for which image should be displayed with contours

Deltavel

Range to intergated the velocity over

Downhill

Downhill contours

Filename

Output file name

Font

The axes font

HighScale

The highest value to plot

Invert

Invert the color table

Levels

Contour levels

Limits

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

LowScale

The lowest value to plot

Max_value

Max value for contours - used with nlevels keyword

Mask

Output mask

Min_value

Max value for contours - used with nlevels keyword

Minor

Minor tick marks

NLevels

Number of contour levels

NoAxis

Don't plot the axis

NoBar

Don't plot the color bar

OutFile

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

Position

The position of the plot in the window

Quit

Quit after loaded - good for immediate output of ps files

RegionFile

Region file to load

Reverse

Reverse the color table

Scale_To_Image

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

Scaling

Which type of scaling to use

Sexadecimal

Sexadecimal numbers on axes

Subtitle

Subtitle

TickColor

Tickmark color

Ticklen

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

Ticks

Major tick marks

Title

Title printed above plot

tlbid

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

Velocity

The velocity of the 3-D image to display

Wid

This is an output variable for the main draw window ID

XTitle

The X-Axis title

YTitle

The Y-Axis title

topPlot_Fits__Define

Plot_Fits__Define