./toolbox/io
io_sdfits_z__define.pro

IO
|
+-IO_SDFITS
  |
  +-IO_SDFITS_LINE
    |
    +-io_sdfits_z

All known superclasses:

IO_SDFITS_LINE, IO_SDFITS, IO

Last modification date:

Wed Sep 28 13:27:14 2016

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

Routine Summary  7 routines

function IO_SDFITS_Z::init(index_file=index_file)
IO_SDFITS_Z is intended for end users wishing to work with zpectrometer data.

procedure IO_SDFITS_Z::cleanup
Class destructor

function IO_SDFITS_Z::group_row_info(row_info)	private
Groups a collection of rows from the index file by file and extension.

function IO_SDFITS_Z::get_rows(_EXTRA=_EXTRA)
Temporary function to use as interface until we can think of a better name then get_spectra

function IO_SDFITS_Z::rows_to_dc(rows, group, missing, virtuals, apply_offsets)	private
Function to convert rows into data containers.

function IO_SDFITS_Z::append_virtuals(spectra, virtuals)
Given an array of data containers and a structure representing virtual columns in an extension table (keywords), appends these virtuals to each data container and returns the new array

procedure io_sdfits_z__define	private
defines class structure

Routine Details

IO_SDFITS_Z::init

function IO_SDFITS_Z::init(index_file=index_file)

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

Inherits

io_sdfits_line

Uses

LINE_INDEX SDFITS

Version

$Id$

Keywords
index_file	.

IO_SDFITS_Z::cleanup

procedure IO_SDFITS_Z::cleanup

Class destructor

IO_SDFITS_Z::group_row_info

private

function IO_SDFITS_Z::group_row_info(row_info)

Groups a collection of rows from the index file by file and extension. This method is needed since we will want to access each files extension only once to read the pertinent rows (for efficiany reasons).

Returns

array of group_row_info structures: rows that share a file and extension

IO_SDFITS_Z::get_rows

function IO_SDFITS_Z::get_rows(_EXTRA=_EXTRA)

Temporary function to use as interface until we can think of a better name then get_spectra

Keywords
_EXTRA	.

IO_SDFITS_Z::rows_to_dc

private

function IO_SDFITS_Z::rows_to_dc(rows, group, missing, virtuals, apply_offsets)

Function to convert rows into data containers. This is used internally in get_spectra. group, missing, apply_offsets are not used here but are needed by the signature of this function.

Parameters
rows	.
group	.
missing	.
virtuals	.
apply_offsets	.

IO_SDFITS_Z::append_virtuals

function IO_SDFITS_Z::append_virtuals(spectra, virtuals)

Given an array of data containers and a structure representing virtual columns in an extension table (keywords), appends these virtuals to each data container and returns the new array

Returns

the original array of data containers, but with each element containing the virtuals

io_sdfits_z__define

private

procedure io_sdfits_z__define

defines class structure