|
Developer Documentation |
|||||||||
prev file | next file | ||||||||||
SUMMARY: fields | routine DETAILS: routine | ||||||||||
./toolbox/io cntm_sdfits__define.pro
FITS | +-SDFITS | +-cntm_sdfits
This Class provides an interface for reading/writing sdfits files that contain continuum data
Fields inherited from FITS: | ||||||||||||||||||||
|
Routine Summary 10 routines |
procedure cntm_sdfits__define | |
This Class provides an interface for reading/writing sdfits files that contain continuum data |
function CNTM_SDFITS::init([file_name], [/new], _EXTRA=_EXTRA) | |
Class Constructor - if file name passed and file exists, file's validity checked |
function CNTM_SDFITS::check_file_validity(_EXTRA=_EXTRA) | |
Checks file for basic validity, and also that it contains continuum data |
function CNTM_SDFITS::get_scan_starts(extension) | |
For a given extension, returns the row numbers that represent the start of a scan |
function CNTM_SDFITS::get_cntm_scan_properties(ext, start_row, end_row, project, samplers, sigs, cals, sampler_pols) | |
Determine the significant properites of the continuum scan starting at the row given. |
function CNTM_SDFITS::get_cntm_data(extension, start, num_rows, stride, data, missing, virtuals) | |
Retrieves the data for this scan. |
function CNTM_SDFITS::get_double_column(lun, col_name, missing, start, end_row, index) | private |
Wrapper to fxbread for doubles NOTE: fxbread uses 1-based row numbers |
function CNTM_SDFITS::get_float_column(lun, col_name, missing, start, end_row, index) | private |
Wrapper to fxbread for floats NOTE: fxbread uses 1-based row numbers |
function CNTM_SDFITS::get_string_column(lun, col_name, missing, start, end_row, default, index) | private |
Wrapper to fxbread NOTE: fxbread uses 1-based row numbers |
function CNTM_SDFITS::get_column(lun, col_name, missing, start, end_row, default, index) | private |
Wrapper to fxbread NOTE: fxbread uses 1-based row numbers |
Routine Details |
cntm_sdfits__define |
procedure cntm_sdfits__define |
This Class provides an interface for reading/writing sdfits files that contain continuum data
CNTM_SDFITS::init |
function CNTM_SDFITS::init([file_name], [/new], _EXTRA=_EXTRA) |
Class Constructor - if file name passed and file exists, file's validity checked
Parameters | |
file_name |
full path name to sdfits file |
Keywords | |
new |
is this a new file? |
_EXTRA |
. |
CNTM_SDFITS::check_file_validity |
function CNTM_SDFITS::check_file_validity(_EXTRA=_EXTRA) |
Checks file for basic validity, and also that it contains continuum data
Keywords | |
_EXTRA |
. |
CNTM_SDFITS::get_scan_starts |
function CNTM_SDFITS::get_scan_starts(extension) |
For a given extension, returns the row numbers that represent the start of a scan
Parameters | |
extension |
extension number (1-based) |
CNTM_SDFITS::get_cntm_scan_properties |
function CNTM_SDFITS::get_cntm_scan_properties(ext, start_row, end_row, project, samplers, sigs, cals, sampler_pols) |
Determine the significant properites of the continuum scan starting at the row given. Continuum data is interwoven and spread across rows; using mrdfits here would be inefficient; thus we read only the first row, and then certain columns.
CNTM_SDFITS::get_cntm_data |
function CNTM_SDFITS::get_cntm_data(extension, start, num_rows, stride, data, missing, virtuals) |
Retrieves the data for this scan. Unlike spectral line data, continuum data is dispersed across more then one row, and interwoven for one scan. Thus what is accomplished with spectral line by reading just one row is more complicated here.
CNTM_SDFITS::get_double_column | private |
function CNTM_SDFITS::get_double_column(lun, col_name, missing, start, end_row, index) |
Wrapper to fxbread for doubles NOTE: fxbread uses 1-based row numbers
Parameters | |
lun |
. |
col_name |
. |
missing |
. |
start |
. |
end_row |
. |
index |
. |
CNTM_SDFITS::get_float_column | private |
function CNTM_SDFITS::get_float_column(lun, col_name, missing, start, end_row, index) |
Wrapper to fxbread for floats NOTE: fxbread uses 1-based row numbers
Parameters | |
lun |
. |
col_name |
. |
missing |
. |
start |
. |
end_row |
. |
index |
. |
CNTM_SDFITS::get_string_column | private |
function CNTM_SDFITS::get_string_column(lun, col_name, missing, start, end_row, default, index) |
Wrapper to fxbread NOTE: fxbread uses 1-based row numbers
Parameters | |
lun |
. |
col_name |
. |
missing |
. |
start |
. |
end_row |
. |
default |
. |
index |
. |
CNTM_SDFITS::get_column | private |
function CNTM_SDFITS::get_column(lun, col_name, missing, start, end_row, default, index) |
Wrapper to fxbread NOTE: fxbread uses 1-based row numbers
Parameters | |
lun |
. |
col_name |
. |
missing |
. |
start |
. |
end_row |
. |
default |
. |
index |
. |