./toolbox/io
File cntm_index__define.pro

INDEX_FILE
|
+-cntm_index

All known superclasses:

INDEX_FILE

Last modification date:

Wed Dec 8 11:57:36 2004

Child class of INDEX_FILE, contains special functionality for dealing with continuum 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  5 routines

procedure cntm_index__define
Child class of INDEX_FILE, contains special functionality for dealing with continuum data.

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

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

procedure CNTM_INDEX::update_file_with_scan, first_row, proj, file_name, ext, start_row, n_data, samplers, sigs, cals, pols
Appends row info to an index file, given a group of rows from sdfits files.

function CNTM_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

cntm_index__define

procedure cntm_index__define

Child class of INDEX_FILE, contains special functionality for dealing with continuum 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 structures, each element corresponding to a line 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
START_ROWS in, optional long	What sdfits row numbers to search for
NUM_ROWS in, optional long	What number of rows to search for
STRIDE in, optional long	What stride 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 numbers to search for
POL in, optional string	What polarizations to search for
IF_NUM in, optional long	What if numbers to search for
SIG in, optional string	What sig states to search for
CAL in, optional string	What cal states to search for

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

Uses

CNTM_INDEX::parse_scan_info CNTM_INDEX::update_index_file

Parameters
first_row in struct	represents the first row in the sdfits file of the scan
proj in string	project for scan
file_name in string	file location
ext in long	extension location
start_row in long	where this scan starts in the extension
n_data in long	length of a continuum in this scan
samplers in array	array of sampler names used in this scan
sigs in array	array of unique signal states in scan
cals in array	array of unique cal states in scan
pols in array	array of polarizations for each sampler

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