NRAO Home  >  Green Bank  |  Wiki Topic:    GB > Data > IDLMain > IDLContents > IDLGuideStructureV2pt0
   Changes | Index | Contents | Search | Statistics | Jump to Topic
GBTIDL V2.0 - Global GUIDE Structure Description

  Main     Status     Design Issues     Examples     Documentation  

This table describes the contents of the global GUIDE structure. This structure is available at !g. It contains values used and set by the procedures and functions that make up GUIDE, and is what allows those procedures and functions to exist with fewer required arguments than would otherwise be necessary.

Constants are found in the !gc structure.

The data containers are described here. From there, there are additional links to tables showing the fields found in each type of data container. You can also click on those links in the table below. A short note on the use of the data containers in !g follows this table.

Note: Colors are initialized first by setcolors (from Tim Robishaw, source found in lib/colors of the GBTIDL distribution). This sets some global values to integers that corresponds to indicies in the IDL color table which map to those named colors. These system global colors are !black, !red, !orange, !green, !forest, !yellow, !cyan, !blue, !magenta, !purple, !gray, and !white.

Note: The list of molecules at !g.molecules is not filled until molecule is used. moleculeread is called by molecule and that procedure is what actually fills !g.molecules.

Name Type Default Description
version string '2.0' A version identifier for this version of gbtidl
s spectrum array empty spectrum 16 spectrum data structures
c continuum array empty continuum 16 continuum data structures
lineio io_sdfits_line object not connected An io_sdfits_line object
contio io_sdfits_cntm object not connected An io_sdfits_cntm object
lineoutio io_sdfits_writer object GBTIDL_KEEP.fits An io_sdfits_writer object
line_filein_name string   The last argument to filein,dirin, or online in "line" mode
cont_filein_name string   The last argument to filin or dirin in "cont" mode
line_fileout_name string GBTIDL_KEEP.fits The last argument to fileout
frozen long integer 0 When true, the plotter is not updated (frozen) after !g.s[0] or !g.c[0] is changed.
sprotect long integer 1 When true, you can not overwrite an NSAVE in fileout. "s" refers to "save".
line long integer 1 When true, !g.s and !g.lineio are used, else =!g.c and !g.contio.
plotter_axis_type long integer 1 0=Channels, 1=Frequency, 2=Velocity
has_display long integer 1 Used to distinguish sessions that cannot use a plotter
interactive long integer 1 Will be 0 for non-interactive sessions (e.g. cron jobs)
background long integer !black default background color
foreground long integer !white default foreground color
showcolor long integer !red default color for "show"
oshowcolor long integer !white default color for "oshow"
crosshaircolor long integer !green default crosshair color
zlinecolor long integer !green default zero-line color
markercolor long integer !green default marker color
annotatecolor long integer !green default color for annotate
oplotcolor long integer !white default color for oplot
vlinecolor long integer !green default vline color
zoomcolor long integer !cyan default color for zoom box
gshowcolor long integer !white default color for gshow
gausstextcolor long integer !white default color for gshow text
highlightcolor long integer !cyan default color for highlighted data (fitgauss, gmeasure)
colorpostscript long integer 1 If not true, generated postscript will be black and white, ignoring any colors.
astack pointer 0 Array of long integers. Typically used to hold index numbers for use by get or kget.
acount long integer 0 Number of values of astack actually used.
accumbuf Array of 4 accum_struct structures empty accum_struct An array of 4 accum buffers used by accum, ave, et al.
regions long integer array All -1 2D with shape [2,100] array holding regions to use in fitting. Actual regions in use are given by nregion.
nregion long integer 0 Total number of regions in regions that are in use currently. [*,0:(nregion-1)]
regionboxes long integer 0 When true, the region boxes on the plotter are persistent as new plots are shown
nfit long integer -1 most recent polynomial order for a baseline fit (bshape and baseline).
polyfit double array 0 2D array holding the parameters of the most recent baseline fit. The shape is [4,51] and [*,0:nfit] are in use at any time.
polfitrms double array 0 1D array holding RMS for each of the (nfit+1) polynomials in the most recent baseline fit. Shape is [51] and [0:nfit] are in use at any time.
gauss gauss structure gauss defaults The structure used by the Gaussian fitting routines
printer string PRINTER environment variable from the unix shell Identifies the printer to use.
tau0 float 0.0 zenith tau
ap_eff float 0.7 aperture efficiency
nsave long integer -1 Most recent NSAVE used.
user_list_cols string   Comma-separated list of index column names. Used by list and liststack when /user is set.
find find_struct structure '' The find structure. Fore use with find, setfind, and clearfind.
molecules Array of 4000 molecule_struct structures empty A structure used by molecule.
nmol long integer 0 Number of elements of molecules in use.

Notes on use of the data containers at !g.s and !g.c

Like UniPOPS, GUIDE uses a global data container, stored in memory, for operations such as get, keep, baseline, hanning, etc. In GUIDE, this global structure is referred to as the Primary Data Container (PDC) and it can be accessed via the global variable !g.s[0] (spectrum) or !g.c[0] (continuum). Operations that required two or more data containers such as add, subtract, and copy must be given indices of the two operands. A total of 16 global data structures each for continua and spectra are provided as a convenient place to hold intermediate results. These are called !g.s[0], !g.s[1], ..., !g.s[15] and !g.c[0], !g.c[1], ..., !g.c[15]. The PDC as well as data containers 1 and 2 may be used and altered by GUIDE procedures and functions so users should use those with care so that important results are not over-written through use of GUIDE commands.

Global Constants

Global constants are found in !gc. This is a read-only global structure.

Name Type Value Description
light_speed double 2.99792458d8 The speed of light in m/s
light_c double 2.99792458d5 The speed of light in km/s
plank_h double 6.6260755D-27 Planck constant
newt_g double 6.67259D-8 Newton gravitational constant in dyne cm^2 gm^-2
boltz_k double 1.380658D-16 Boltzman constant in erg K-1
eV2erg double 1.60217733D-12 1 eV to ergs
AU double 1.4960D+13 AU in cm
m_H double 1.673534D-24 hydrogen mass in gm
m_e double 9.1093897D-28 electron mass in gm
pc double 3.0857D+18 1 parsec in cm
rad_sig double 5.67051D-5 radiation constant in erg cm-2 s-1 K-4

-- BobGarwood - 13 Apr 2006

Topic IDLGuideStructureV2pt0 . { Edit | Attach | Ref-By | Printable | Diffs | r1.3 | > | r1.2 | > | r1.1 | More }
Revision r1.3 - 27 Apr 2006 - 17:40 GMT - BobGarwood
Parents: IDLMain > IDLContents 		Content copyright © 1999-2007 by the contributing authors.
All material on this collaboration platform is the property of the contributing authors.