#include <VLAContinuumRecord.h>

Inheritance diagram for VLAContinuumRecord:

Public Member Functions
	VLAContinuumRecord ()
	The default constructor creates a unusable object. More...

	VLAContinuumRecord (casacore::ByteSource &record, casacore::uInt offset)
	Initialise this ContinuumRecord from the given record with the specified offset. More...

virtual	~VLAContinuumRecord ()
	The destructor is trivial. More...

void	attach (casacore::ByteSource &record, casacore::uInt offset)
	Initialise this VLAContinuumRecord from the given BytesSource (which must contain a VLA logical record), and must be readable & seekable. More...

virtual casacore::Vector < casacore::Complex >	data () const
	returns the correlations for this baseline. More...

virtual void	data (casacore::Array< casacore::Complex > &values) const
	Returns the correlations for this baseline in the supplied Array. More...

virtual casacore::Vector < casacore::Bool >	flags () const
	returns the flags for the correlations for this baseline. More...

casacore::Vector< casacore::Float >	variance () const
	returns the variance of the correlations for this baseline. More...

virtual casacore::uInt	scale () const
	returns the scaling factor used to convert the internal data to the actual values. More...

virtual casacore::uInt	ant1 () const
	returns the antenna 1 index for this baseline. More...

virtual casacore::uInt	ant2 () const
	returns the antenna 2 index for this baseline. More...

virtual VLABaselineRecord::Type	type () const
	Return the type of this record (ie., CONTINUUM). More...

Public Member Functions inherited from VLABaselineRecord
virtual	~VLABaselineRecord ()
	A virtual destructor is needed to ensure that the destructor of derived classes is actually used. More...

Private Member Functions
	VLAContinuumRecord (const VLAContinuumRecord &other)

VLAContinuumRecord &	operator= (const VLAContinuumRecord &other)

Additional Inherited Members
Public Types inherited from VLABaselineRecord
enum	Type { CONTINUUM, SPECTRALLINE, UNKNOWN_TYPE, NUMBER_TYPES }
	The shapes of all the components. More...

Static Public Member Functions inherited from VLABaselineRecord
static casacore::String	name (VLABaselineRecord::Type typeEnum)
	Convert a Type enum into a String. More...

static VLABaselineRecord::Type	type (const casacore::String &typeName)
	Convert a given casacore::String to a Type enumerator. More...

Protected Member Functions inherited from VLABaselineRecord
	VLABaselineRecord ()
	function to turn an object constructed this way into a usable object. More...

	VLABaselineRecord (casacore::ByteSource &record, casacore::uInt offset)

void	attach (casacore::ByteSource &record, casacore::uInt offset)

casacore::uInt	scale (casacore::uInt headerOffset) const

casacore::uInt	ant1 (casacore::uInt headerOffset) const

casacore::uInt	ant2 (casacore::uInt headerOffset) const

Protected Attributes inherited from VLABaselineRecord
casacore::ByteSource	itsRecord

casacore::uInt	itsOffset

Detailed Description

Intended use:

Public interface

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

Definition at line 91 of file VLAContinuumRecord.h.

Constructor & Destructor Documentation

VLAContinuumRecord::VLAContinuumRecord ( )

The default constructor creates a unusable object.

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

VLAContinuumRecord::VLAContinuumRecord	(	casacore::ByteSource &	record,
		casacore::uInt	offset
	)

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

virtual VLAContinuumRecord::~VLAContinuumRecord ( )

virtual

The destructor is trivial.

VLAContinuumRecord::VLAContinuumRecord ( const VLAContinuumRecord & other )

private

Member Function Documentation

virtual casacore::uInt VLAContinuumRecord::ant1 ( ) const

virtual

returns the antenna 1 index for this baseline.

Implements VLABaselineRecord.

virtual casacore::uInt VLAContinuumRecord::ant2 ( ) const

virtual

returns the antenna 2 index for this baseline.

Implements VLABaselineRecord.

void VLAContinuumRecord::attach	(	casacore::ByteSource &	record,
		casacore::uInt	offset
	)

Initialise this VLAContinuumRecord from the given BytesSource (which must contain a VLA logical record), and must be readable & seekable.

The offset specifies where the record starts.

virtual casacore::Vector<casacore::Complex> VLAContinuumRecord::data ( ) const

virtual

returns the correlations for this baseline.

This will be a casacore::Vector with four elements containing the AA, CC, AC & CA (or BB, DD, BD, DB) correlations (ie all four polarisations). The returned casacore::Vector has been scaled.

Reimplemented from VLABaselineRecord.

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

virtual

Returns the correlations for this baseline in the supplied Array.

The supplied casacore::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 casacore::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 casacore::Array has four elements containing the AA, CC, AC & CA (or BB, DD, BD, DB) correlations (ie all four polarisations).

Implements VLABaselineRecord.

virtual casacore::Vector<casacore::Bool> VLAContinuumRecord::flags ( ) const

virtual

returns the flags for the correlations for this baseline.

The returned casacore::Vector will always have a length of four.

Implements VLABaselineRecord.

VLAContinuumRecord& VLAContinuumRecord::operator= ( const VLAContinuumRecord & other )

private

virtual casacore::uInt VLAContinuumRecord::scale ( ) const

virtual

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