./toolbox/io
File index_file__define.pro

Last modification date:

Wed Dec 8 11:57:37 2004

Base Class used for profiling contents of sdfits files inside an ASCII file. File has two main sections: the header section contains generic info, while the rows section is a mapping of 'data containers' (spectra or continua) to their location in sdfits files. See UML for all IO Classes, or INDEX UML for just index classes.

Routine Summary  22 routines

procedure index_file__define
Base Class used for profiling contents of sdfits files inside an ASCII file.

function INDEX_FILE::init([file_name=string], [version=string])
Class Constructor - flags and constants set here.

procedure INDEX_FILE::set_file_name, file_name
Sets file name of index file

procedure INDEX_FILE::set_file_path, file_path
Sets path to index file

function INDEX_FILE::get_file_name()
Retrieves file name of index file

function INDEX_FILE::is_file_loaded()
Finds if object contains index file's contents in memory

procedure INDEX_FILE::set_version, version
Sets version number of I/O modules

function INDEX_FILE::get_version()
Retrieves the version number of the I/O module using this object

procedure INDEX_FILE::list, rows=rows, verbose=verbose
Prints the rows section of the index file for those rows specified

procedure INDEX_FILE::read_file, [file_name=string]
Loads contents of index file into memory.

function INDEX_FILE::get_header_value(keyword[, status])
Retrieves values from the header section of the index file.

procedure INDEX_FILE::list_header
Prints contents of index header section

function INDEX_FILE::search_for_row_info(_EXTRA=_EXTRA)
Given the search parameters used by search_index, returns the structures representing those rows in the index file

function INDEX_FILE::search_row_location(_EXTRA=_EXTRA)
Given the search parameters used by search_index, returns the structures representing the locations of each row in the index file in their sdfits files

procedure INDEX_FILE::new_file, observer, backend, tcal_table, file_path, [file_name=string]
Creates a new index file, initializing the header section

function INDEX_FILE::get_column_values(column, [/unique])
Retrieves values found for a column in the index file (all the files for exampler).

procedure INDEX_FILE::write_index_file, header_strings, [rows_info=array]
Takes a given header section and list of rows, and writes them to a file

procedure INDEX_FILE::update_index_file, rows_info
Appends new rows to the end of the rows section of index file

function INDEX_FILE::check_index_with_reality([expanded], [/verbose])
Checks the contents of the index file with the actual charcteristics of the files it lists, looking for inconsistencies

function INDEX_FILE::check_io_version_number()
Compares io version number found in index file with number coded in object

procedure INDEX_FILE::set_debug_on
Makes object verbose

procedure INDEX_FILE::set_debug_off
Makes object quiet

Routine Details

index_file__define

procedure index_file__define

Base Class used for profiling contents of sdfits files inside an ASCII file. File has two main sections: the header section contains generic info, while the rows section is a mapping of 'data containers' (spectra or continua) to their location in sdfits files. See UML for all IO Classes, or INDEX UML for just index classes.

Class Constructor - flags and constants set here.

Keywords
file_name in, optional string	file name of index file
version in, optional string	version number

Sets file name of index file

Parameters
file_name in string	name of index file

Sets path to index file

Parameters
file_path in string	path to index file

Retrieves file name of index file

Returns

file name of index file

Finds if object contains index file's contents in memory

Returns

0,1

Sets version number of I/O modules

Parameters
version in string	version number

Retrieves the version number of the I/O module using this object

Returns

version number (string)

Prints the rows section of the index file for those rows specified

Keywords
rows	the row numbers which are to be printed
verbose	set to true and ALL info on each row is printed, otherwise just select columns printed

Loads contents of index file into memory. Sets file loaded flag to True.

Uses

INDEX_FILE::read_file_format INDEX_FILE::read_file_header INDEX_FILE::read_file_rows

Keywords
file_name in, optional string	file name of index file

Retrieves values from the header section of the index file. Problem: why is this class not using a key_value_parser object?

Parameters
keyword in array	the keyword whose value is needed
status out, optional boolean	was the keyword found?

Prints contents of index header section

Given the search parameters used by search_index, returns the structures representing those rows in the index file

Returns

array of structures representing the found rows of the index file

Uses

INDEX_FILE::search_index

Keywords
_EXTRA	.

Given the search parameters used by search_index, returns the structures representing the locations of each row in the index file in their sdfits files

Returns

array of structures representing the locations of each found row

Uses

INDEX_FILE::search_index

Keywords
_EXTRA	.

Creates a new index file, initializing the header section

Uses

INDEX_FILE::set_file_name INDEX_FILE::new_header_string INDEX_FILE::write_index_file

Parameters
observer in string	observer
backend in string	backends used in the listed observations
tcal_table in string	table used for tcal values (not currently implemented)
file_path in string	path where all sdfits files can be found

Keywords
file_name in, optional string	name of index file can be specified here

Retrieves values found for a column in the index file (all the files for exampler).

Returns

the values found for a column in the index file

Uses

INDEX_FILE::get_row_info_strct

Parameters
column in string	name of column to query

Keywords
unique in, optional boolean	just return the unique values for this column?

Takes a given header section and list of rows, and writes them to a file

Parameters
header_strings in array	string array of key-value pairs for header section

Keywords
rows_info in, optional array	array of structures representing rows for index file

Appends new rows to the end of the rows section of index file

Parameters
rows_info in array	array of structures representing rows to be appended

Checks the contents of the index file with the actual charcteristics of the files it lists, looking for inconsistencies

Returns

0,1

Uses

INDEX_FILE::get_full_file_name INDEX_FILE::check_io_version_number INDEX_FILE::is_file_loaded INDEX_FILE::file_exists INDEX_FILE::check_file_properties

Parameters
expanded in, optional boolean	is it allowable that an sdfits file has grown since this index file was created?

Keywords
verbose in, optional boolean	print details of all errors?

Compares io version number found in index file with number coded in object

Returns

0,1

Uses

INDEX_FILE::get_header_value

Makes object verbose

Makes object quiet