VLABaselineRecord.h

Classes

VLABaselineRecord -- (full description)

class VLABaselineRecord

Types

enum Type

CONTINUUM = 0
A simple point component

SPECTRALLINE
A elliptical Gaussian component

UNKNOWN_TYPE
An unknown Component

NUMBER_TYPES
The number of types in this enumerator

Interface

Public Members

virtual ~VLABaselineRecord()

virtual Vector<Complex> data() const

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

virtual Vector<Bool> flags() const = 0

virtual uInt scale() const = 0

virtual uInt ant1() const = 0

virtual uInt ant2() const = 0

virtual VLABaselineRecord::Type type() const = 0

static String name(VLABaselineRecord::Type typeEnum)

static VLABaselineRecord::Type type(const String& typeName)

Protected Members

VLABaselineRecord()

VLABaselineRecord(ByteSource& record, uInt offset)

void attach(ByteSource& record, uInt offset)

uInt scale(uInt headerOffset) const

uInt ant1(uInt headerOffset) const

uInt ant2(uInt headerOffset) const

Private Members

VLABaselineRecord(const VLABaselineRecord& other)

VLABaselineRecord& operator=(const VLABaselineRecord& 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

virtual ~VLABaselineRecord()

A virtual destructor is needed to ensure that the destructor of derived classes is actually used.

virtual Vector<Complex> data() const

returns the correlations for this baseline. The returned Vector contains all the data for this baseline and has been scaled.

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

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.

virtual Vector<Bool> flags() const = 0

returns the flags for the correlations for this baseline.

virtual uInt scale() const = 0

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

virtual uInt ant1() const = 0

returns the antenna 1 index for this baseline.

virtual uInt ant2() const = 0

returns the antenna 2 index for this baseline.

virtual VLABaselineRecord::Type type() const = 0

return the type of this class

static String name(VLABaselineRecord::Type typeEnum)

Convert a Type enum into a String

static VLABaselineRecord::Type type(const String& typeName)

Convert a given String to a Type enumerator

VLABaselineRecord()

function to turn an object constructed this way into a usable object.