./toolbox/io
File sdfits__define.pro

FITS
|
+-sdfits

All known superclasses:

FITS

Last modification date:

Wed Dec 8 11:57:40 2004

This class has all the same functionality as its superclass FITS, but contains specail handling for known characteristics of sdfits files, for example what columns to expect in an extension.

Routine Summary  6 routines

procedure sdfits__define
This class has all the same functionality as its superclass FITS, but contains specail handling for known characteristics of sdfits files, for example what columns to expect in an extension.

function SDFITS::get_and_eval_rows(missing, virtuals, row_nums, [ext=long], [/all_rows])
Retrieves rows from an sdfits file, and finds what columsn are missing, and what the important keywords are in the header

function SDFITS::get_missing_columns(present)
Finds what the missing columns are in a list of columns found in an sdfits file

function SDFITS::get_expected_col_names()
Retrives the names of columns expected to be found in an sdfits file

function SDFITS::check_sdfits_properties(file_name=file_name, verbose=verbose)
Checks sdfits file of this object (or of keyword) to see if it meets certain criteria: does it exist? does it have more then one extension? Is the last extension binary and of type 'SINGLE DISH'? keyword file_name {in}{optional}{type=string} file to check keword verbose {in}{optional}{type=boolean} print details when error found?

function SDFITS::define_sdfits_row(data_points)
Defines an anonymos structure that mirrors a row in an sdfits file.

Routine Details

sdfits__define

procedure sdfits__define

This class has all the same functionality as its superclass FITS, but contains specail handling for known characteristics of sdfits files, for example what columns to expect in an extension.

Inherits

fits

Retrieves rows from an sdfits file, and finds what columsn are missing, and what the important keywords are in the header

Returns

array of structures representing the rows read in from sdfits extension

Uses

mredfits SDFITS::get_virtual_columns SDFITS::get_missing_columns

Parameters
missing out array	string array of columns found to be missing
virtuals out struct	keyword-value pairs in header that dont describe columns
row_nums in array	row numbers to read

Keywords
ext in, optional long	extension number to read from
all_rows in, optional boolean	read all rows from extension?

Finds what the missing columns are in a list of columns found in an sdfits file

Returns

those columns that were expected but not found

Uses

SDFITS::get_expected_col_names

Parameters
present in array	list of columns present in sdfits extension

Retrives the names of columns expected to be found in an sdfits file

Returns

expected column names

Uses

SDFITS::define_sdfits_row

Checks sdfits file of this object (or of keyword) to see if it meets certain criteria: does it exist? does it have more then one extension? Is the last extension binary and of type 'SINGLE DISH'? keyword file_name {in}{optional}{type=string} file to check keword verbose {in}{optional}{type=boolean} print details when error found?

Returns

0,1

Keywords
file_name	.
verbose	.

Defines an anonymos structure that mirrors a row in an sdfits file. Must be anonymos so that the DATA columns length can be defined at run-time. Problems: this exists here AND in IO_SDFITS_WRITER

Returns

structure mirroring row of an sdfits file

Uses

SDFITS::get_sdfits_row_sizes

Parameters
data_points in array	length of DATA column