Produced by IDL 6.1
Developer Documentation

./toolbox/io
line_index_section__define.pro

INDEX_FILE_SECTION
|
+-ROWS_INDEX_SECTION
  |
  +-line_index_section

All known superclasses:
ROWS_INDEX_SECTION, INDEX_FILE_SECTION
Last modification date:
Thu Jun 2 23:56:08 2005

This class extends the rows_index_section class to properly manage the rows section for a spectral line index file; that is, an index file where each row line represents a spectrum.

Fields inherited from ROWS_INDEX_SECTION:
pointer  ROWS
pointer  FRMT
pointer  FRMT_QUIET
pointer  FRMT_USER
string  FLOAT_FORMAT
string  FORMAT_STRING
string  FORMAT_HEADER
string  FORMAT_STRING_QUIET
string  FORMAT_HEADER_QUIET
string  FORMAT_STRING_USER
string  FORMAT_HEADER_USER
integer  MORE_FORMAT

Fields inherited from INDEX_FILE_SECTION:
longword integer  LINES_INCR
longword integer  MAX_LINE_WIDTH
longword integer  NUM_LINES
string  FILENAME
longword integer  LUN
string  SECTION_MARKER
pointer  LINE_NUMS
pointer  LINES
longword integer  SECTION_READ
longword integer  ALLOW_APPEND
longword integer  PAD_WIDTH
longword integer  DEBUG

Routine Summary  4 routines

procedure line_index_section__define

This class extends the rows_index_section class to properly manage the rows section for a spectral line index file; that is, an index file where each row line represents a spectrum.

function LINE_INDEX_SECTION::init(lun, filename)

private

Class Constructor Here the formats for the rows are determined: how to list them verbosly and quietly.

function LINE_INDEX_SECTION::get_row_info_strct()

private

Returns the specail structure needed for spectal line data

procedure LINE_INDEX_SECTION::list_quiet, rows, [/pproj], [/pfile], [/pext], [/prow], [/pscan], [/psub], [/pbeam], [/psig], [/pcal], [/paz], [/pel], [/plng], [/plat], [/plst], [/prest], [/pvel], [/pres], [/pdate], [/pband], [/pexp], [/ptsys]

private

When the list command is issued without the verbose command, this method prints only the columns selected in self.

Routine Details

line_index_section__define

procedure line_index_section__define

This class extends the rows_index_section class to properly manage the rows section for a spectral line index file; that is, an index file where each row line represents a spectrum.

Inherits
rows_index_section

LINE_INDEX_SECTION::init private

function LINE_INDEX_SECTION::init(lun, filename)

Class Constructor Here the formats for the rows are determined: how to list them verbosly and quietly.

Parameters
lun
.
filename
.

LINE_INDEX_SECTION::get_row_info_strct private

function LINE_INDEX_SECTION::get_row_info_strct()

Returns the specail structure needed for spectal line data

Returns
line_row_info_strct structure

LINE_INDEX_SECTION::list_quiet private

procedure LINE_INDEX_SECTION::list_quiet, rows, [/pproj], [/pfile], [/pext], [/prow], [/pscan], [/psub], [/pbeam], [/psig], [/pcal], [/paz], [/pel], [/plng], [/plat], [/plst], [/prest], [/pvel], [/pres], [/pdate], [/pband], [/pexp], [/ptsys]

When the list command is issued without the verbose command, this method prints only the columns selected in self.frmt_quiet, and also prints any additional info requested via the many keywords

Parameters
rows
.

Keywords
pproj
in, optional
boolean
prints the column labeled PROJ
pfile
in, optional
boolean
prints the column labeled FILE
pext
in, optional
boolean
prints the column labeled EXT
prow
in, optional
boolean
prints the column labeled ROW
pscan
in, optional
boolean
prints the column labeled SCAN
psub
in, optional
boolean
prints the column labeled SUB
pbeam
in, optional
boolean
prints the column labeled BEAM
psig
in, optional
boolean
prints the column labeled SIG
pcal
in, optional
boolean
prints the column labeled CAL
paz
in, optional
boolean
prints the column labeled AZIMUTH
pel
in, optional
boolean
prints the column labeled ELEVATION
plng
in, optional
boolean
prints the column labeled LONGITUDE AXIS
plat
in, optional
boolean
prints the column labeled LATITUDE AXIS
plst
in, optional
boolean
prints the column labeled LST
prest
in, optional
boolean
prints the column labeled REST FREQ
pvel
in, optional
boolean
prints the column labeled VELOCITY
pres
in, optional
boolean
prints the column labeled RESOLUTION
pdate
in, optional
boolean
prints the column labeled DATE_OBS
pband
in, optional
boolean
prints the column labeled BANDWIDTH
pexp
in, optional
boolean
prints the column labeled EXPOSURE
ptsys
in, optional
boolean
prints the column labeled TSYS


Produced by IDLdoc 1.6 on Thu Jun 2 23:56:38 2005