VLASpectralLineRecord.h

Classes

VLASpectralLineRecord -- (full description)

class VLASpectralLineRecord: public VLABaselineRecord

Interface

Public Members

VLASpectralLineRecord()

VLASpectralLineRecord(ByteSource& record, uInt offset, uInt nChan)

virtual ~VLASpectralLineRecord()

void attach(ByteSource& record, uInt offset, uInt nChan)

virtual Vector<Complex> data() const

virtual void data(Array<Complex>& values) const

virtual Vector<Bool> flags() const

virtual uInt scale() const

virtual uInt ant1() const

virtual uInt ant2() const

virtual VLABaselineRecord::Type type() const

Private Members

VLASpectralLineRecord(const VLASpectralLineRecord& other)

VLASpectralLineRecord& operator=(const VLASpectralLineRecord& other)

Description

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

SomeClass
SomeOtherClass
some concept

Etymology

Synopsis

Example

Motivation

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

add this feature
fix this bug
start discussion of this possible extension

Member Description

VLASpectralLineRecord()

The default constructor creates a unusable object. Use the attach function to turn an object constructed this way into a usable object.

VLASpectralLineRecord(ByteSource& record, uInt offset, uInt nChan)

Initialise this SpectralLineRecord from the given record with the specified offset.

virtual ~VLASpectralLineRecord()

The destructor is trivial

void attach(ByteSource& record, uInt offset, uInt nChan)

Initialise this VLASpectralLineRecord from the given BytesSource (which must contain a VLA logical record), and must be readable & seekable. The offset specifies where the record starts and the number of channels in this record must be specified.

virtual Vector<Complex> data() const

returns the correlations for this baseline. This will be a Vector containing the correlations, at one polarisation, for all the channels. The returned Vector has been scaled.

virtual void data(Array<Complex>& values) const

Returns the correlations for this baseline in the supplied Array. The supplied Array may have any number of dimensions, but all except one must have a length on 1. The axis that is not of length one must be the right length to hold all the data contained in the record. Alternatively the Array may contain no elements in which case it will be resized to a Vector of the correct length. The returned values have been scaled.

The returned Array will contain the correlations, at one polarisation, for all the channels.

virtual Vector<Bool> flags() const

returns the flags for the correlations for this baseline. The returned Vector will always have a length of four.

virtual uInt scale() const

returns the scaling factor used to convert the internal data to the actual values.