./toolbox/io
cntm_sdfits__define.pro

FITS
|
+-SDFITS
  |
  +-cntm_sdfits

All known superclasses:

SDFITS, FITS

Last modification date:

Wed Sep 28 13:27:14 2016

This Class provides an interface for reading/writing sdfits files that contain continuum data

Fields inherited from SDFITS:

string   FITSVER string   SDFITVER string   SDFITVER_NUMBER longword integer   FROM_GBTIDL longword integer   AUTO_OFFSETS

Fields inherited from FITS:

string   FILE_NAME longword integer   NUM_EXTENSIONS pointer   EXTENSION_NAMES pointer   EXTENSION_TYPES pointer   AXIS object reference   PRIMARY_HEADER object reference   EXT_HEADER longword integer   PROPERTIES_KNOWN longword integer   DEBUG string   VERSION

Routine Summary  11 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, nanmissing=nanmissing)	private
Wrapper to fxbread for doubles NOTE: fxbread uses 1-based row numbers NOTE: this lun was returned by a previous call to fxbopen

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 NOTE: lun was returned by a previous call to fxbopen

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 NOTE: lun was returned by a previous call to fxbopen

function CNTM_SDFITS::get_short_int_column(lun, col_name, missing, start, end_row, default, index)	private
Wrapper to fxbread for short ints NOTE: fxbread uses 1-based row numbers NOTE: this lun was returned by a previous call to fxbopen

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 NOTE: lun was returned by a previous call to fxbopen

Routine Details

cntm_sdfits__define

procedure cntm_sdfits__define

This Class provides an interface for reading/writing sdfits files that contain continuum data

Inherits

sdfits

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

Uses

CNTM_SDFITS::check_file_validity

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

Returns

0,1

Uses

SDFITS::check_sdfits_properites

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

Returns

row numbers that are at the start of a scan

Uses

fxbopen fxbread fxbclose

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.

Returns

the first row of the scan

Uses

SDFITS::get_and eval_rows CNTM_SDFITS::get_column fxbopen fxbclose

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.

Returns

first row of continuum data

Uses

SDFITS::get_and_eval_rows CNTM_SDFITS::get_float_column CNTM_SDFITS::get_string_column fxbopen fxbclose

CNTM_SDFITS::get_double_column

private

function CNTM_SDFITS::get_double_column(lun, col_name, missing, start, end_row, index, nanmissing=nanmissing)

Wrapper to fxbread for doubles NOTE: fxbread uses 1-based row numbers NOTE: this lun was returned by a previous call to fxbopen

Parameters
lun	.
col_name	.
missing	.
start	.
end_row	.
index	.

Keywords
nanmissing	.

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 NOTE: lun was returned by a previous call to fxbopen

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 NOTE: lun was returned by a previous call to fxbopen

Parameters
lun	.
col_name	.
missing	.
start	.
end_row	.
default	.
index	.

CNTM_SDFITS::get_short_int_column

private

function CNTM_SDFITS::get_short_int_column(lun, col_name, missing, start, end_row, default, index)

Wrapper to fxbread for short ints NOTE: fxbread uses 1-based row numbers NOTE: this lun was returned by a previous call to fxbopen

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 NOTE: lun was returned by a previous call to fxbopen

Parameters
lun	.
col_name	.
missing	.
start	.
end_row	.
default	.
index	.