A class to provide easy read-only access to MSASpectralWindow columns. More...

#include <MSSpWindowColumns.h>

Inheritance diagram for casacore::ROMSSpWindowColumns:

Public Member Functions
	ROMSSpWindowColumns (const MSSpectralWindow &msSpWindow)
	Create a columns object that accesses the data in the specified Table. More...

	~ROMSSpWindowColumns ()
	The destructor does nothing special. More...

const ROArrayColumn< Double > &	chanFreq () const
	Access to columns. More...

const ROArrayQuantColumn < Double > &	chanFreqQuant () const

const ROArrayMeasColumn < MFrequency > &	chanFreqMeas () const

const ROArrayColumn< Double > &	chanWidth () const

const ROArrayQuantColumn < Double > &	chanWidthQuant () const

const ROArrayColumn< Double > &	effectiveBW () const

const ROArrayQuantColumn < Double > &	effectiveBWQuant () const

const ROScalarColumn< Int > &	freqGroup () const

const ROScalarColumn< String > &	freqGroupName () const

const ROScalarColumn< Int > &	ifConvChain () const

const ROScalarColumn< Bool > &	flagRow () const

const ROScalarColumn< Int > &	measFreqRef () const

const ROScalarColumn< String > &	name () const

const ROScalarColumn< Int > &	netSideband () const

const ROScalarColumn< Int > &	numChan () const

const ROScalarColumn< Double > &	refFrequency () const

const ROScalarQuantColumn < Double > &	refFrequencyQuant () const

const ROScalarMeasColumn < MFrequency > &	refFrequencyMeas () const

const ROArrayColumn< Double > &	resolution () const

const ROArrayQuantColumn < Double > &	resolutionQuant () const

const ROScalarColumn< Double > &	totalBandwidth () const

const ROScalarQuantColumn < Double > &	totalBandwidthQuant () const

const ROArrayColumn< String > &	assocNature () const
	Access to optional columns. More...

const ROArrayColumn< Int > &	assocSpwId () const

const ROScalarColumn< Int > &	bbcNo () const

const ROScalarColumn< Int > &	bbcSideband () const

const ROScalarColumn< Int > &	dopplerId () const

const ROScalarColumn< Int > &	receiverId () const

uInt	nrow () const
	Convenience function that returns the number of rows in any of the columns. More...

Int	matchSpw (const MFrequency &refFreq, uInt nChan, const Quantum< Double > &bandwidth, Int ifChain, const Quantum< Double > &tolerance, Int tryRow=-1) const
	returns the last row that contains a spectral window that has the specified reference frequency, number of channels, total-bandwidth and IF conversion chain. More...

Int	matchSpw (const MFrequency &refFreq, const MFrequency &chanFreq1, const MeasFrame &measFrm, const MSDopplerColumns &msdopc, const MSSourceColumns &mssrcc, uInt nChan, const Quantum< Double > &bandwidth, Int ifChain, const Quantum< Double > &tolerance, Int tryRow=-1) const
	Similar to above, but also pass in the frame info. More...

Vector< Int >	allMatchedSpw (const MFrequency &refFreq, uInt nChan, const Quantum< Double > &bandwidth, Int ifChain, const Quantum< Double > &tolerance) const
	This is to check that the channels are matched individually and also if the spw is matched in reverse;. More...

Int	matchSpw (const MFrequency &refFreq, uInt nChan, const Quantum< Double > &bandwidth, Int ifChain, const Quantum< Double > &tolerance, Vector< Double > &otherFreqs, Bool &reversed) const
	This version does a channel to channel match too and also return the reversed if it matches but the channels are in inverse order like an upper or lower side band having same characteristics. More...

Protected Member Functions
	ROMSSpWindowColumns ()

void	attach (const MSSpectralWindow &msSpWindow)

Private Member Functions
	ROMSSpWindowColumns (const ROMSSpWindowColumns &)

ROMSSpWindowColumns &	operator= (const ROMSSpWindowColumns &)

void	attachOptionalCols (const MSSpectralWindow &msSpWindow)

Bool	matchRefFrequency (uInt row, MFrequency::Types refType, Double refFreqInHz, Double tolInHz) const

Bool	matchRefFreqCnvtrd (uInt row, MFrequency refOrChanFreq, const Bool isRefFreq, const MeasFrame &measFrm, const MSDopplerColumns &msdopc, const MSSourceColumns &mssrcc, Double tolInHz) const

Bool	matchChanFreq (uInt row, const Vector< Double > &chanFreqInHz, Double tolInHz) const

Bool	matchIfConvChain (uInt row, Int ifChain) const

Bool	matchTotalBandwidth (uInt row, Double bandwidthInHz, Double tolInHz) const

Bool	matchNumChan (uInt row, Int nChan) const

Private Attributes
ROArrayColumn< Double >	chanFreq_p

ROArrayColumn< Double >	chanWidth_p

ROArrayColumn< Double >	effectiveBW_p

ROScalarColumn< Bool >	flagRow_p

ROScalarColumn< Int >	freqGroup_p

ROScalarColumn< String >	freqGroupName_p

ROScalarColumn< Int >	ifConvChain_p

ROScalarColumn< Int >	measFreqRef_p

ROScalarColumn< String >	name_p

ROScalarColumn< Int >	netSideband_p

ROScalarColumn< Int >	numChan_p

ROScalarColumn< Double >	refFrequency_p

ROArrayColumn< Double >	resolution_p

ROScalarColumn< Double >	totalBandwidth_p

ROArrayColumn< String >	assocNature_p

ROArrayColumn< Int >	assocSpwId_p

ROScalarColumn< Int >	bbcNo_p

ROScalarColumn< Int >	bbcSideband_p

ROScalarColumn< Int >	dopplerId_p

ROScalarColumn< Int >	receiverId_p

ROArrayMeasColumn< MFrequency >	chanFreqMeas_p

ROScalarMeasColumn< MFrequency >	refFrequencyMeas_p

ROArrayQuantColumn< Double >	chanFreqQuant_p

ROArrayQuantColumn< Double >	chanWidthQuant_p

ROArrayQuantColumn< Double >	effectiveBWQuant_p

ROScalarQuantColumn< Double >	refFrequencyQuant_p

ROArrayQuantColumn< Double >	resolutionQuant_p

ROScalarQuantColumn< Double >	totalBandwidthQuant_p

Detailed Description

A class to provide easy read-only access to MSASpectralWindow columns.

Intended use:

Public interface

Review Status

Reviewed By:: Bob Garwood
Date Reviewed:: 1997/02/01

Prerequisite

Etymology

ROMSSpectralWindowColumns stands for Read-Only MeasurementSet SpectralWindow Table columns.

Synopsis

This class provides read-only access to the columns in the MSSpectralWindow Table. It does the declaration of all the Scalar and ArrayColumns with the correct types, so the application programmer doesn't have to worry about getting those right. There is an access function for every predefined column. Access to non-predefined columns will still have to be done with explicit declarations. See ROMSColumns for an example.

Motivation

See MSColumns for the motivation.

Definition at line 82 of file MSSpWindowColumns.h.

Constructor & Destructor Documentation

casacore::ROMSSpWindowColumns::ROMSSpWindowColumns ( const MSSpectralWindow & msSpWindow )

Create a columns object that accesses the data in the specified Table.

casacore::ROMSSpWindowColumns::~ROMSSpWindowColumns ( )

The destructor does nothing special.

casacore::ROMSSpWindowColumns::ROMSSpWindowColumns ( )

protected

casacore::ROMSSpWindowColumns::ROMSSpWindowColumns ( const ROMSSpWindowColumns & )

private

Member Function Documentation

Vector<Int> casacore::ROMSSpWindowColumns::allMatchedSpw	(	const MFrequency &	refFreq,
		uInt	nChan,
		const Quantum< Double > &	bandwidth,
		Int	ifChain,
		const Quantum< Double > &	tolerance
	)		const

This is to check that the channels are matched individually and also if the spw is matched in reverse;.

Same as the above but returns all the possible match that it could find in the spectral window table.

const ROArrayColumn<String>& casacore::ROMSSpWindowColumns::assocNature ( ) const

inline

Access to optional columns.

Definition at line 128 of file MSSpWindowColumns.h.

References assocNature_p.

Referenced by casacore::MSSpWindowColumns::assocNature().

const ROArrayColumn<Int>& casacore::ROMSSpWindowColumns::assocSpwId ( ) const

inline

Definition at line 129 of file MSSpWindowColumns.h.

References assocSpwId_p.

Referenced by casacore::MSSpWindowColumns::assocSpwId().

void casacore::ROMSSpWindowColumns::attach ( const MSSpectralWindow & msSpWindow )

protected

void casacore::ROMSSpWindowColumns::attachOptionalCols ( const MSSpectralWindow & msSpWindow )

private

const ROScalarColumn<Int>& casacore::ROMSSpWindowColumns::bbcNo ( ) const

inline

Definition at line 130 of file MSSpWindowColumns.h.

References bbcNo_p.

Referenced by casacore::MSSpWindowColumns::bbcNo().

const ROScalarColumn<Int>& casacore::ROMSSpWindowColumns::bbcSideband ( ) const

inline

Definition at line 131 of file MSSpWindowColumns.h.

References bbcSideband_p.

Referenced by casacore::MSSpWindowColumns::bbcSideband().

const ROArrayColumn<Double>& casacore::ROMSSpWindowColumns::chanFreq ( ) const

inline

Access to columns.

Definition at line 93 of file MSSpWindowColumns.h.

References chanFreq_p.

Referenced by casacore::MSSpWindowColumns::chanFreq().

const ROArrayMeasColumn<MFrequency>& casacore::ROMSSpWindowColumns::chanFreqMeas ( ) const

inline

Definition at line 96 of file MSSpWindowColumns.h.

References chanFreqMeas_p.

Referenced by casacore::MSSpWindowColumns::chanFreqMeas().

const ROArrayQuantColumn<Double>& casacore::ROMSSpWindowColumns::chanFreqQuant ( ) const

inline

Definition at line 94 of file MSSpWindowColumns.h.

References chanFreqQuant_p.

Referenced by casacore::MSSpWindowColumns::chanFreqQuant().

const ROArrayColumn<Double>& casacore::ROMSSpWindowColumns::chanWidth ( ) const

inline

Definition at line 98 of file MSSpWindowColumns.h.

References chanWidth_p.

Referenced by casacore::MSSpWindowColumns::chanWidth().

const ROArrayQuantColumn<Double>& casacore::ROMSSpWindowColumns::chanWidthQuant ( ) const

inline

Definition at line 99 of file MSSpWindowColumns.h.

References chanWidthQuant_p.

Referenced by casacore::MSSpWindowColumns::chanWidthQuant().

const ROScalarColumn<Int>& casacore::ROMSSpWindowColumns::dopplerId ( ) const

inline

Definition at line 132 of file MSSpWindowColumns.h.

References dopplerId_p.

Referenced by casacore::MSSpWindowColumns::dopplerId().

const ROArrayColumn<Double>& casacore::ROMSSpWindowColumns::effectiveBW ( ) const

inline

Definition at line 101 of file MSSpWindowColumns.h.

References effectiveBW_p.

Referenced by casacore::MSSpWindowColumns::effectiveBW().

const ROArrayQuantColumn<Double>& casacore::ROMSSpWindowColumns::effectiveBWQuant ( ) const

inline

Definition at line 102 of file MSSpWindowColumns.h.

References effectiveBWQuant_p.

Referenced by casacore::MSSpWindowColumns::effectiveBWQuant().

const ROScalarColumn<Bool>& casacore::ROMSSpWindowColumns::flagRow ( ) const

inline

Definition at line 107 of file MSSpWindowColumns.h.

References flagRow_p.

Referenced by casacore::MSSpWindowColumns::flagRow().

const ROScalarColumn<Int>& casacore::ROMSSpWindowColumns::freqGroup ( ) const

inline

Definition at line 104 of file MSSpWindowColumns.h.

References freqGroup_p.

Referenced by casacore::MSSpWindowColumns::freqGroup().

const ROScalarColumn<String>& casacore::ROMSSpWindowColumns::freqGroupName ( ) const

inline

Definition at line 105 of file MSSpWindowColumns.h.

References freqGroupName_p.

Referenced by casacore::MSSpWindowColumns::freqGroupName().

const ROScalarColumn<Int>& casacore::ROMSSpWindowColumns::ifConvChain ( ) const

inline

Definition at line 106 of file MSSpWindowColumns.h.

References ifConvChain_p.

Referenced by casacore::MSSpWindowColumns::ifConvChain().

Bool casacore::ROMSSpWindowColumns::matchChanFreq	(	uInt	row,
		const Vector< Double > &	chanFreqInHz,
		Double	tolInHz
	)		const

private

Bool casacore::ROMSSpWindowColumns::matchIfConvChain	(	uInt	row,
		Int	ifChain
	)		const

private

Bool casacore::ROMSSpWindowColumns::matchNumChan	(	uInt	row,
		Int	nChan
	)		const

private

Bool casacore::ROMSSpWindowColumns::matchRefFreqCnvtrd	(	uInt	row,
		MFrequency	refOrChanFreq,
		const Bool	isRefFreq,
		const MeasFrame &	measFrm,
		const MSDopplerColumns &	msdopc,
		const MSSourceColumns &	mssrcc,
		Double	tolInHz
	)		const

private

Bool casacore::ROMSSpWindowColumns::matchRefFrequency	(	uInt	row,
		MFrequency::Types	refType,
		Double	refFreqInHz,
		Double	tolInHz
	)		const

private

Int casacore::ROMSSpWindowColumns::matchSpw	(	const MFrequency &	refFreq,
		uInt	nChan,
		const Quantum< Double > &	bandwidth,
		Int	ifChain,
		const Quantum< Double > &	tolerance,
		Int	tryRow = `-1`
	)		const

returns the last row that contains a spectral window that has the specified reference frequency, number of channels, total-bandwidth and IF conversion chain.

All frequencies need to match within the specified tolerance. Both the totalBandwidth & the tolerance arguments must have the same dimensions as the Hz and an AipsError exception is thrown, in debug mode, if the dimensions are wrong. In addition to the numerical values the frequency reference frame is checked and needs to match the value in the MEAS_FREQ_REF column. No conversions to other reference frames are done. Will only try to match on rows where FLAG_ROW is false. If tryRow is set to a non-negative value then that row is checked first to see if it matches. An AIpsError exception is thrown if tryRow is bigger than the number of rows in the Table. Returns -1 if no match could be found.

Int casacore::ROMSSpWindowColumns::matchSpw	(	const MFrequency &	refFreq,
		const MFrequency &	chanFreq1,
		const MeasFrame &	measFrm,
		const MSDopplerColumns &	msdopc,
		const MSSourceColumns &	mssrcc,
		uInt	nChan,
		const Quantum< Double > &	bandwidth,
		Int	ifChain,
		const Quantum< Double > &	tolerance,
		Int	tryRow = `-1`
	)		const

Similar to above, but also pass in the frame info.

Int casacore::ROMSSpWindowColumns::matchSpw	(	const MFrequency &	refFreq,
		uInt	nChan,
		const Quantum< Double > &	bandwidth,
		Int	ifChain,
		const Quantum< Double > &	tolerance,
		Vector< Double > &	otherFreqs,
		Bool &	reversed
	)		const

This version does a channel to channel match too and also return the reversed if it matches but the channels are in inverse order like an upper or lower side band having same characteristics.