./toolbox/io
io_sdfits_cntm__define.pro

IO
|
+-IO_SDFITS
  |
  +-io_sdfits_cntm

All known superclasses:

IO_SDFITS, IO

Last modification date:

Wed Sep 28 13:27:14 2016

IO_SDFITS_LINE is intended for end users wishing to work with continuum data. It's the child class of IO_SDFITS used for reading, writing, navigating sdfits continuum line files, and for translating their info to continuum data containers. See UML for all IO Classes, or IO_SDFITS UML for just the line and continuum sdfits classes.

Fields inherited from IO_SDFITS:

string   FILE_PATH pointer   FITS_FILES object reference   INDEX object reference   FLAGS longword integer   INDEX_SYNCED longword integer   UPDATE_EXPANDED_FILES longword integer   ONE_FILE string   OBSERVER string   TCAL_TABLE string   BACKEND longword integer   LAST_RECORD longword integer   ONLINE longword integer   UPDATE_IN_PROGRESS object reference   ONLINE_STATUS longword integer   DEBUG

Fields inherited from IO:

string   VERSION

Routine Summary  14 routines

procedure io_sdfits_cntm__define
IO_SDFITS_CNTM is intended for end users wishing to work with continuum data.

function IO_SDFITS_CNTM::init()	private
Constructor

function IO_SDFITS_CNTM::get_continua([count], indicies, [_EXTRA=_EXTRA])
This function searches the index file using the keyword parameters passed into it, reads the appropriate parts of the sdfits files, and tranlates this data into continuum structures, which are returned.

function IO_SDFITS_CNTM::get_continua_from_group(group)	private
Retrieves Continua data containers from a group of sdfits rows from the same extension.

function IO_SDFITS_CNTM::cntm_data_to_cntm_container(row, data, missing, virtuals, if_number)	private
Translates continuum data derived from an sdfits file and index file into a Continuum data container.

function IO_SDFITS_CNTM::group_row_info(row_info)	private
Groups rows from index file according to file-extension

procedure IO_SDFITS_CNTM::update_index_with_fits_file, fits	private
Updates the index file with all the information from the passed in sdfits file

procedure IO_SDFITS_CNTM::free_group_row_info, row_info	private
frees the memory in each element of this array

function IO_SDFITS_CNTM::get_new_fits_obj(file_name, _EXTRA=_EXTRA)	private
creates and returns a new object to represent an sdfits continuum file

procedure IO_SDFITS_CNTM::load_new_sdfits_rows
Stub method for updating the index file.

procedure IO_SDFITS_CNTM::update
Stub method for updating the index file.

procedure IO_SDFITS_CNTM::set_online, file_name
Stub method for updating the index file.

function IO_SDFITS_CNTM::get_index_class_name()

function IO_SDFITS_CNTM::get_index_section_class_name()

Routine Details

io_sdfits_cntm__define

procedure io_sdfits_cntm__define

IO_SDFITS_CNTM is intended for end users wishing to work with continuum data. It's the child class of IO_SDFITS used for reading, writing, navigating sdfits continuum files, and for translating their info to continuum data containers. See UML for all IO Classes, or IO_SDFITS UML for just the line and continuum sdfits classes.

Inherits

io_sdfits

Uses

LINE_INDEX SDFITS

Version

$Id$

IO_SDFITS_CNTM::init

private

function IO_SDFITS_CNTM::init()

Constructor

Uses

IO_SDFITS::init

IO_SDFITS_CNTM::get_continua

function IO_SDFITS_CNTM::get_continua([count], indicies, [_EXTRA=_EXTRA])

This function searches the index file using the keyword parameters passed into it, reads the appropriate parts of the sdfits files, and tranlates this data into continuum structures, which are returned.

Returns

Array of spectrum structures

Examples

Uses

CNTM_INDEX::search_for_row_info IO_SDFITS_CNTM::get_continua_from_group

Version

$Id$

IO_SDFITS_CNTM::get_continua_from_group

private

function IO_SDFITS_CNTM::get_continua_from_group(group)

Retrieves Continua data containers from a group of sdfits rows from the same extension.

Parameters
group in struct	structure that contains all the info needed for extracting continua from sdfits.

IO_SDFITS_CNTM::cntm_data_to_cntm_container

private

function IO_SDFITS_CNTM::cntm_data_to_cntm_container(row, data, missing, virtuals, if_number)

Translates continuum data derived from an sdfits file and index file into a Continuum data container.

Uses

IO_SDFITS::get_row_value fitsdateparse mjd juldate IO_SDFITS::coord_mode_from_types IO_SDFITS::format_sdfits_polarization IO_SDFITS::format_sdfits_procedure IO_SDFITS::translate_sig IO_SDFITS::translate_cal

IO_SDFITS_CNTM::group_row_info

private

function IO_SDFITS_CNTM::group_row_info(row_info)

Groups rows from index file according to file-extension

Returns

same structures passed in, but grouped by file-extension

IO_SDFITS_CNTM::update_index_with_fits_file

private

procedure IO_SDFITS_CNTM::update_index_with_fits_file, fits

Updates the index file with all the information from the passed in sdfits file

Uses

CNTM_SDFITS::get_cntm_scan_properties CNTM_INDEX::update_index_with_scan INDEX_FILE::read_file

IO_SDFITS_CNTM::free_group_row_info

private

procedure IO_SDFITS_CNTM::free_group_row_info, row_info

frees the memory in each element of this array

Parameters
row_info in array	array of structures

IO_SDFITS_CNTM::get_new_fits_obj

private

function IO_SDFITS_CNTM::get_new_fits_obj(file_name, _EXTRA=_EXTRA)

creates and returns a new object to represent an sdfits continuum file

Returns

object of cntm_sdfits class

IO_SDFITS_CNTM::load_new_sdfits_rows

procedure IO_SDFITS_CNTM::load_new_sdfits_rows

Stub method for updating the index file. TBD.

IO_SDFITS_CNTM::update

procedure IO_SDFITS_CNTM::update

Stub method for updating the index file. TBD.

IO_SDFITS_CNTM::set_online

procedure IO_SDFITS_CNTM::set_online, file_name

Stub method for updating the index file. TBD.

Parameters
file_name	.

IO_SDFITS_CNTM::get_index_class_name

function IO_SDFITS_CNTM::get_index_class_name()

IO_SDFITS_CNTM::get_index_section_class_name

function IO_SDFITS_CNTM::get_index_section_class_name()