|
Developer Documentation |
|||||||||
prev file | next file | ||||||||||
SUMMARY: fields | routine DETAILS: routine | ||||||||||
./toolbox/io io_sdfits_cntm__define.pro
IO | +-IO_SDFITS | +-io_sdfits_cntm
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: | ||||||||||||||||||||||
|
Fields inherited from IO: | ||
|
Routine Summary 12 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. |
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.
IO_SDFITS_CNTM::init | private |
function IO_SDFITS_CNTM::init() |
Constructor
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.
Parameters | |
count |
number of continua returned |
indicies |
. |
Keywords | |
_EXTRA |
see search_for_row_info for more info |
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 |
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.
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
Parameters | |
row_info |
array of structs mirroring rows of index file |
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
Parameters | |
fits |
object that represents sdfits files whose info is feed to index 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 |
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
Parameters | |
file_name |
full path name to the file to be represented by object |
Keywords | |
_EXTRA |
. |
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 |
. |