SDFITSDataIterator.h

Classes

SDFITSDataIterator -- Steps through an SDFITS DATA cell, serving up chunks appropriate for an MS. (full description)

class SDFITSDataIterator

Interface

Public Members

SDFITSDataIterator()

~SDFITSDataIterator()

Bool setrow(const Record &row, String &errMsg)

const Matrix<Float>& floatData()

const Vector<Double>& frequencies()

Double freqAxisAtRefPix()

Double freqAxisDelt()

MFrequency::Types freqRefType()

MDoppler::Types dopplerType()

const Vector<Int>& stokes()

const MDirection& direction()

const MEpoch& time()

const MVTime& exposure()

const Vector<Double> &timeRange()

Int beamId()

Bool hasBeamAxis()

Int receiverId()

Bool hasReceiverAxis()

void next()

void origin()

Bool atEnd()

Vector<Bool> &handledColumns()

Private Members

Bool init(const Record &row, String &errMsg)

void setValues()

Int indexedFieldNumber(const Record &row, const String &field, Int index)

SDFITSDataIterator(const SDFITSDataIterator &)

SDFITSDataIterator &operator=(const SDFITSDataIterator &)

Description

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• SDFITS
• MS

Etymology

Synopsis

Example

Motivation

Thrown Exceptions

To Do

• full use of field units for all handled keywords
• use appropriate defaults when not exactly standard SDFITS
• better error handling, warnings and errors
• issue warnings just once for each setup
• better behavior of class members when things go bad
• handled data-like fields as well as DATA (TMATXnnn=T fields)

Member Description

SDFITSDataIterator()

~SDFITSDataIterator()

Bool setrow(const Record &row, String &errMsg)

initialize everything for this row, the cursor is reset at the start

const Matrix<Float>& floatData()

the DATA pointed to by the current cursor, in the order expected for use by the MS - nstokes, nfreq

const Vector<Double>& frequencies()

the vector of frequencies associated with floatData, in Hz

Double freqAxisAtRefPix()

from original axis description, the frequency axis value at the reference channel

Double freqAxisDelt()

from original axis description, cdelt

MFrequency::Types freqRefType()

the frequency reference type

MDoppler::Types dopplerType()

the velocity definition

const Vector<Int>& stokes()

the stokes values

const MDirection& direction()

the direction at the current cursor location

const MEpoch& time()

the time at the current cursor location, this will also take into account other time-related keywords/columns in the fits table

const MVTime& exposure()

The exposure

const Vector<Double> &timeRange()

The time range, in the same Measure reference frame as time()

Int beamId()

the beam ID at the current cursor location. This defaults to a value of 1 if no BEAM axis is present.

Bool hasBeamAxis()

is there a BEAM axis

Int receiverId()

the receiver ID at the current cursor location. This defaults to a value of 1 if no RECEIVER axis is present.

Bool hasReceiverAxis()

Is there a RECEIVER axis

void next()

Move the cursor to the next location

void origin()

Move the cursor back to the origin

Bool atEnd()

At the end of the iterator

Vector<Bool> &handledColumns()

which columns are handled here

Bool init(const Record &row, String &errMsg)

initialize the internals which depend on the row description

void setValues()

set the values after the cursor has moved or been reset

Int indexedFieldNumber(const Record &row, const String &field, Int index)

utility function to get the fieldNumber for an indexed keyword, eg. CTYPE2

SDFITSDataIterator(const SDFITSDataIterator &)

undefined and inaccessible

SDFITSDataIterator &operator=(const SDFITSDataIterator &)