./toolbox/io
cntm_index__define.pro

INDEX_FILE
|
+-cntm_index

All known superclasses:

INDEX_FILE

Last modification date:

Wed Sep 28 13:27:14 2016

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. This class is responsible for establishing the correct class for managing the row section of the index file, the translation between sdfits and index rows, and provides the search gateway.

Fields inherited from INDEX_FILE:

string   FILE_NAME longword integer   FILE_LOADED string   FILE_PATH object reference   HEADER object reference   ROWS string   ROWS_CLASS pointer   ROW_LINES string   VERSION longword integer   SPROTECT structure [1]  INFO longword integer   DEBUG

Routine Summary  9 routines

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

function CNTM_INDEX::init(_EXTRA=_EXTRA)

function CNTM_INDEX::get_row_info_strct()	private
Returns the specail structure needed for continuum data

function CNTM_INDEX::search_index([start][, finish], SEARCH=SEARCH, [INDEX=long], [PROJECT=string], [FILE=string], [EXTENSION=long], [FIRSTROW=long], [NUMROWS=long], [STRIDE=long], [SOURCE=string], [PROCEDURE=string], [OBSID=string], [PROCSCAN=string], [PROCTYPE=string], [SCAN=long ], [PROCSEQN=long ], [E2ESCAN=long ], [POLARIZATION=string], [IFNUM=long ], [TRGTLONG=float], [TRGTLAT=float], [SIG=string], [CAL=string], [NSAVE=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::parse_scan_info(first_row, proj, file_name, ext, start_row, n_data, unique_samplers, sigs, cals, sampler_pols)	private
Takes in information about a continuum scan, and converts that to several rows in the index file.

function CNTM_INDEX::check_file_properties(file_name[, expanded], [/verbose])	private
Checks basic file properties to see if they agree with what the index file has listed.

function CNTM_INDEX::get_scan_info(scan_number[, file], count=variable, [/quiet])
Returns an array of structures that contains info about the scan number given, such as scan number, procedure name, number of integrations, ifs, etc.

procedure CNTM_INDEX::get_file_properties_in_index, file_name, extensions, num_rows	private
Finds the number and sizes of extensions for a file listed in the index file, according to the index file.

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. This class is responsible for establishing the correct class for managing the row section of the index file, the translation between sdfits and index rows, and provides the search gateway.

CNTM_INDEX::init

function CNTM_INDEX::init(_EXTRA=_EXTRA)

Keywords
_EXTRA	.

CNTM_INDEX::get_row_info_strct

private

function CNTM_INDEX::get_row_info_strct()

Returns the specail structure needed for continuum data

Returns

cntm_row_info_strct structure

CNTM_INDEX::search_index

function CNTM_INDEX::search_index([start][, finish], SEARCH=SEARCH, [INDEX=long], [PROJECT=string], [FILE=string], [EXTENSION=long], [FIRSTROW=long], [NUMROWS=long], [STRIDE=long], [SOURCE=string], [PROCEDURE=string], [OBSID=string], [PROCSCAN=string], [PROCTYPE=string], [SCAN=long ], [PROCSEQN=long ], [E2ESCAN=long ], [POLARIZATION=string], [IFNUM=long ], [TRGTLONG=float], [TRGTLAT=float], [SIG=string], [CAL=string], [NSAVE=string])

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

CNTM_INDEX::update_file_with_scan

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. Used for first loading in an sdfits file

Uses

CNTM_INDEX::parse_scan_info CNTM_INDEX::update_index_file

CNTM_INDEX::parse_scan_info

private

function CNTM_INDEX::parse_scan_info(first_row, proj, file_name, ext, start_row, n_data, unique_samplers, sigs, cals, sampler_pols)

Takes in information about a continuum scan, and converts that to several rows in the index file. A single scan may have several continua (or rows in index) depending on the switching type, receiver type, etc...

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, should be zero for the first scan
n_data in long	length of a continuum in this scan
unique_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
sampler_pols in array	array of polarizations for each sampler returns array of structures representing new rows for the index file (all for just this scan)

CNTM_INDEX::check_file_properties

private

function CNTM_INDEX::check_file_properties(file_name[, expanded], [/verbose])

Checks basic file properties to see if they agree with what the index file has listed.

Returns

0,1

CNTM_INDEX::get_scan_info

function CNTM_INDEX::get_scan_info(scan_number[, file], count=variable, [/quiet])

Returns an array of structures that contains info about the scan number given, such as scan number, procedure name, number of integrations, ifs, etc.. One element in the array for each unique FILE value for all rows having that scan number (there is no TIMESTAMP available yet for continuum data).

Returns

array of structures containing info on scan, returns -1 on failure.

CNTM_INDEX::get_file_properties_in_index

private

procedure CNTM_INDEX::get_file_properties_in_index, file_name, extensions, num_rows

Finds the number and sizes of extensions for a file listed in the index file, according to the index file.

Uses

INDEX_FILE::search_for_row_info