./plotter
getstate.pro

Last modification date:

Wed Sep 28 13:27:10 2016

This is a collection of routines that return information found in the gbtplot_common common block. They exist so that users don't need to include that common block in their code and so that they don't need to know specifically where that information is in the common block. Developers of the plotter can then feel free to move that information around so long as these functions still return it correctly.

Routine Summary  10 routines

function getxarray([count=variable])
Get the current x-array.

function getxunits()
Get the current x-axis units.

function getxveldef()
Get the current x-axis velocity definition.

function getxvoffset()
Get the current x-axis velocity offset.

function getxoffset()
Get the current x-axis offset.

function getxframe()
Get the current x-axis reference frame.

function getyarray([count=variable])
Get the current array of y values.

function getplotterdc([/copy])
Get the current data container.

function getxrange([empty=variable])
Get the current x-range

function getyrange([empty=variable])
Get the current y-range

Routine Details

getxarray

function getxarray([count=variable])

Get the current x-array. Useful so that the caller doesn't have to know how the plotter has stored this quantity.

Returns

the current array of x-axis values.

Version

$Id$

Common blocks

gbtplot_common

getxunits

function getxunits()

Get the current x-axis units. Useful so that the caller doesn't have to know how the plotter has stored this quantity.

Returns

the current units of the x-axis.

Common blocks

gbtplot_common

getxveldef

function getxveldef()

Get the current x-axis velocity definition. Useful so that the caller doesn't have to know how the plotter has stored this quantity.

Returns

the current x-axis velocity definition (RADIO, OPTICAL, or TRUE).

Common blocks

gbtplot_common

getxvoffset

function getxvoffset()

Get the current x-axis velocity offset. Useful so that the caller doesn't have to know how the plotter has stored this quantity. The x-axis velocity offset is a true frame shift, not a simple linear offset.

Returns

the current x-axis velocity offset in m/s, using the TRUE velocity definition.

Common blocks

gbtplot_common

getxoffset

function getxoffset()

Get the current x-axis offset. Useful so that the caller doesn't have to know how the plotter has stored this quantity. The x-axis offset is a simple offset so that the real, physical x-axis value is xarray + xoffset.

Returns

the current x-axis offset in the current plotter x-axis units. velocity definition.

Common blocks

gbtplot_common

getxframe

function getxframe()

Get the current x-axis reference frame. Useful so that the caller doesn't have to know how the plotter has stored this quantity.

Returns

the current x-axis reference frame (LSR, LSD, TOPO, GEO, HEL, BAR, GAL).

Common blocks

gbtplot_common

getyarray

function getyarray([count=variable])

Get the current array of y values. Useful so that the caller doesn't have to know how the plotter has stored this quantity.

Returns

the current array of y values.

Common blocks

gbtplot_common

getplotterdc

function getplotterdc([/copy])

Get the current data container. If copy is true, make this a true copy.

If you do not request a true copy then you should not free this data container or change the data values since that will confuse the plotter. If a true copy is returned, you are responsible for calling data_free to free up its pointer when no longer needed.

Useful so that the caller doesn't have to know how the plotter has stored this quantity.

Returns

the current data container.

Common blocks

gbtplot_common

getxrange

function getxrange([empty=variable])

Get the current x-range

Returns

the current x-range

Common blocks

gbtplot_common

getyrange

function getyrange([empty=variable])

Get the current y-range

Returns

the current y-range

Common blocks

gbtplot_common