VLASpectralLineRecord Class Reference

#include <VLASpectralLineRecord.h>

Inheritance diagram for VLASpectralLineRecord:

Public Member Functions
	VLASpectralLineRecord ()
	The default constructor creates a unusable object. More...
	VLASpectralLineRecord (casacore::ByteSource &record, casacore::uInt offset, casacore::uInt nChan)
	Initialise this SpectralLineRecord from the given record with the specified offset. More...
virtual	~VLASpectralLineRecord ()
	The destructor is trivial. More...
void	attach (casacore::ByteSource &record, casacore::uInt offset, casacore::uInt nChan)
	Initialise this VLASpectralLineRecord 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...
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., SPECTRALLINE). 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
	VLASpectralLineRecord (const VLASpectralLineRecord &other)
VLASpectralLineRecord &	operator= (const VLASpectralLineRecord &other)

Private Attributes
casacore::uInt	itsNchan

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 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	(	casacore::ByteSource &	record,
		casacore::uInt	offset,
		casacore::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 casacore::uInt VLASpectralLineRecord::ant1 ( ) const

virtual

returns the antenna 1 index for this baseline.

Implements VLABaselineRecord.

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

virtual

returns the antenna 2 index for this baseline.

Implements VLABaselineRecord.

void VLASpectralLineRecord::attach	(	casacore::ByteSource &	record,
		casacore::uInt	offset,
		casacore::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 casacore::Vector<casacore::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 casacore::Vector has been scaled.

Reimplemented from VLABaselineRecord.

virtual void VLASpectralLineRecord::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 will contain the correlations, at one polarisation, for all the channels.

Implements VLABaselineRecord.

virtual casacore::Vector<casacore::Bool> VLASpectralLineRecord::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.

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

private

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

virtual

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

Implements VLABaselineRecord.

virtual VLABaselineRecord::Type VLASpectralLineRecord::type ( ) const

virtual

Return the type of this record (ie., SPECTRALLINE).

Implements VLABaselineRecord.

Member Data Documentation

casacore::uInt VLASpectralLineRecord::itsNchan

private

Definition at line 151 of file VLASpectralLineRecord.h.

---

The documentation for this class was generated from the following file:

• casa/code/nrao/VLA/VLASpectralLineRecord.h