./toolbox/io
File line_index__define.pro

INDEX_FILE
|
+-line_index

All known superclasses:

INDEX_FILE

Last modification date:

Wed Dec 8 11:57:39 2004

Child class of INDEX_FILE, contains special functionality for dealing with spectral line data. This mostly entails the translation of sdfits data into contents of the index file. See UML for all IO Classes, or INDEX UML for just index classes.

Routine Summary  7 routines

procedure line_index__define
Child class of INDEX_FILE, contains special functionality for dealing with spectral line data.

function LINE_INDEX::init(_EXTRA=_EXTRA)
Class Constructor - special formats for spectral line initialized here

function LINE_INDEX::search_index([INDEX=long], [PROJ=string], [FILES=string], [EXT=long], [ROWS=long], [SOURCE=string], [PROC=string], [MC_SCAN=long], [POL=string], [IF_NUM=long ], [BEAM=long], [INT=long], [SIG=string], [CAL=string])
This method searches the rows in the index file using the optional keywords.

function LINE_INDEX::parse_extension_rows(rows, proj, file_name, ext, missing, virtuals, start)
Translates raw sdfits rows into the rows to be written to the index file.

procedure LINE_INDEX::update_with_spectra, spectra, file_name, extension, start_row
Appends row info to an index file, given a group of spectra.

procedure LINE_INDEX::update_file, ext_rows, proj, file_name, ext, missing, virtuals, start_row
Appends row info to an index file, given a group of rows from sdfits files.

function LINE_INDEX::get_scan_info(scan_number)
Returns a structure that contains info about the scan number given, such as scan number, procedure name, number of integrations, ifs, etc.

Routine Details

line_index__define

procedure line_index__define

Child class of INDEX_FILE, contains special functionality for dealing with spectral line data. This mostly entails the translation of sdfits data into contents of the index file. See UML for all IO Classes, or INDEX UML for just index classes.

Class Constructor - special formats for spectral line initialized here

Keywords
_EXTRA	.

This method searches the rows in the index file using the optional keywords. Not using any keywords returns all rows. Use of more then one keyword is like using an AND.

Returns

Array of longs, each element corresponding to a line number of the index file that matches the search

Keywords
INDEX in, optional long	What index # to search for
PROJ in, optional string	What projects to search for
FILES in, optional string	What sdfits files to search for
EXT in, optional long	What sdfits extension numbers to search for
ROWS in, optional long	What sdfits row numbers to search for
SOURCE in, optional string	What source names to search for
PROC in, optional string	What procecures to search for
MC_SCAN in, optional long	What M&C scan nubmers to search for
POL in, optional string	What polarizations to search for
IF_NUM in, optional long	What if numbers to search for
BEAM in, optional long	What beam numbers to search for
INT in, optional long	What integraion numbers to search for
SIG in, optional string	What sig states to search for
CAL in, optional string	What cal states to search for

Translates raw sdfits rows into the rows to be written to the index file. This is where all the algorithms are implemented for determining if and integration numbers.

Returns

arrays of structures representing lines to be written to index file

Uses

INDEX_FILE::get_row_info_strct LINE_INDEX::get_integreation_number LINE_INDEX::get_if_numbers INDEX_FILE::get_row_value

Parameters
rows in array	array of structs representing sdfits rows
proj in string	project id shared by all rows
file_name in string	file location shared by all rows
ext in long	extension location shared by all rows
missing in array	string array of columns missing from the sdfits file
virtuals in struct	key-value pairs from sdfits extension header (not including col descriptions)
start in long	row number that these rows start it

Appends row info to an index file, given a group of spectra. Used for when these spectra have been written to an sdifts file.

Uses

LINE_INDEX::spectra_to_info LINE_INDEX::update_index_file

Parameters
spectra in array	array of spectrum data containers
file_name in string	file location shared by all extensions
extension in long	extension location shared by all extensions
start_row in long	where these spectra start in the extension

Appends row info to an index file, given a group of rows from sdfits files. Used for first loading in an sdfits file

Uses

LINE_INDEX::spectra_to_info LINE_INDEX::update_index_file

Parameters
ext_rows in array	array of sdfits rows
proj in string	project shared by all rows
file_name in string	file location shared by all extensions
ext in long	extension location shared by all extensions
missing in array	string array of columns missing from the ext_rows param
virtuals in struct	keywords from extension header not describing columns
start_row in long	where these spectra start in the extension

Returns a structure that contains info about the scan number given, such as scan number, procedure name, number of integrations, ifs, etc..

Returns

Structure containing info on scan

Parameters
scan_number in long	scan number information is queried for