MultiBandData Class Reference

Contains information about a set of bands. More...

#include <multibanddata.h>

Public Member Functions
	MultiBandData ()
	Construct an empty MultiBandData.
	MultiBandData (casacore::MSSpectralWindow &spwTable, casacore::MSDataDescription &dataDescTable)
	Construct a MultiBandData from the Measurement Set tables. More...
	MultiBandData (const MultiBandData &source, size_t startChannel, size_t endChannel)
	Construct a MultiBandData from another instance but only select a part of each band data. More...
size_t	BandCount () const
	Get number of bands stored. More...
double	BandEnd () const
	Get the end frequency of the highest frequency channel. More...
double	BandStart () const
	Get the start frequency of the lowest frequency channel. More...
double	Bandwidth () const
	Get total bandwidth covered. More...
double	CentreFrequency () const
	Get centre frequency. More...
size_t	DataDescCount () const
	Returns the unique number of data description IDs. More...
const BandData &	FirstBand () const
	Retrieve the first band. More...
double	HighestFrequency () const
	Get highest frequency. More...
double	LowestFrequency () const
	Get lowest frequency. More...
size_t	MaxChannels () const
	Get the maximum number of channels in a band. More...
const BandData &	operator[] (size_t dataDescID) const
	Index operator to retrieve a band data given a dataDescID. More...

Detailed Description

Contains information about a set of bands.

This follows the CASA Measurement Set model; one MultiBandData instance can contain the band information contained in the CASA Measurement Set.

Constructor & Destructor Documentation

MultiBandData::MultiBandData ( casacore::MSSpectralWindow &  spwTable, casacore::MSDataDescription &  dataDescTable  )

inline

Construct a MultiBandData from the Measurement Set tables.

Parameters

spwTable	The spectral window table of a measurement set.
dataDescTable	The data description table of a measurement set.

MultiBandData::MultiBandData ( const MultiBandData &  source, size_t  startChannel, size_t  endChannel  )

inline

Construct a MultiBandData from another instance but only select a part of each band data.

Parameters

source	Other instance that will be partially copied.
startChannel	Start of channel range to initialize this instance with.
endChannel	End of channel range (exclusive) to initialize this instance with.

Member Function Documentation

size_t MultiBandData::BandCount ( ) const

inline

Get number of bands stored.

Returns

Number of bands.

double MultiBandData::BandEnd ( ) const

inline

Get the end frequency of the highest frequency channel.

Returns

End of covered bandwidth.

double MultiBandData::BandStart ( ) const

inline

Get the start frequency of the lowest frequency channel.

Returns

Start of covered bandwidth.

double MultiBandData::Bandwidth ( ) const

inline

Get total bandwidth covered.

Returns

BandEnd() - BandStart().

double MultiBandData::CentreFrequency ( ) const

inline

Get centre frequency.

Returns

(LowestFrequency() + HighestFrequency()) * 0.5.

size_t MultiBandData::DataDescCount ( ) const

inline

Returns the unique number of data description IDs.

Returns

Unique number of data desc IDs.

const BandData& MultiBandData::FirstBand ( ) const

inline

Retrieve the first band.

Returns

The first band.

double MultiBandData::HighestFrequency ( ) const

inline

Get highest frequency.

Returns

The channel frequency of the channel with highest frequency.

double MultiBandData::LowestFrequency ( ) const

inline

Get lowest frequency.

Returns

The channel frequency of the channel with lowest frequency.

size_t MultiBandData::MaxChannels ( ) const

inline

Get the maximum number of channels in a band.

Returns

Maximum number of channels.

const BandData& MultiBandData::operator[] ( size_t  dataDescID ) const

inline

Index operator to retrieve a band data given a dataDescID.

Parameters

dataDescID

A valid data description ID for which the band is returned.

Returns

The BandData for the requested band.

---

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

• multibanddata.h