#include <VLASpectralLineRecord.h>

Inheritance diagram for VLASpectralLineRecord:

Public Member Functions
	VLASpectralLineRecord ()
	The default constructor creates a unusable 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.
virtual Vector< Complex >	data () const
	returns the correlations for this baseline.
virtual void	data (Array< Complex > &values) const
	Returns the correlations for this baseline in the supplied Array.
virtual Vector< Bool >	flags () const
	returns the flags for the correlations for this baseline.
virtual uInt	scale () const
	returns the scaling factor used to convert the internal data to the actual values.
virtual uInt	ant1 () const
	returns the antenna 1 index for this baseline.
virtual uInt	ant2 () const
	returns the antenna 2 index for this baseline.
virtual VLABaselineRecord::Type	type () const
	Return the type of this record (ie., SPECTRALLINE).
Private Member Functions
	VLASpectralLineRecord (const VLASpectralLineRecord &other)
VLASpectralLineRecord &	operator= (const VLASpectralLineRecord &other)
Private Attributes
uInt	itsNchan

Detailed Description

Intended use:

Public interface

 <h3>Review Status</h3><dl><dt>Date Reviewed:<dd>yyyy/mm/dd</dl>

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 87 of file VLASpectralLineRecord.h.

Constructor & Destructor Documentation

VLASpectralLineRecord::VLASpectralLineRecord ( )

The default constructor creates a unusable object.

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

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

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

virtual VLASpectralLineRecord::~VLASpectralLineRecord ( ) [virtual]

The destructor is trivial.

VLASpectralLineRecord::VLASpectralLineRecord ( const VLASpectralLineRecord & other ) [private]

Member Function Documentation

virtual uInt VLASpectralLineRecord::ant1 ( ) const [virtual]

returns the antenna 1 index for this baseline.

Implements VLABaselineRecord.

virtual uInt VLASpectralLineRecord::ant2 ( ) const [virtual]

returns the antenna 2 index for this baseline.

Implements VLABaselineRecord.

void VLASpectralLineRecord::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> VLASpectralLineRecord::data ( ) const [virtual]

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.

Reimplemented from VLABaselineRecord.

virtual void VLASpectralLineRecord::data ( Array< Complex > & values ) const [virtual]

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.

Implements VLABaselineRecord.

virtual Vector<Bool> VLASpectralLineRecord::flags ( ) const [virtual]

returns the flags for the correlations for this baseline.

The returned Vector will always have a length of four.

Implements VLABaselineRecord.

VLASpectralLineRecord& VLASpectralLineRecord::operator= ( const VLASpectralLineRecord & other ) [private]