MirFreqSetup Class Reference

A description of a Miriad spectroscopy (correlator) setup. More...

#include <FillMetadata.h>

Inheritance diagram for MirFreqSetup:

Public Member Functions
	MirFreqSetup (casacore::Int mir_handle)
	create a new setup by reading the relevent variable data from the given miriad dataset handle More...
virtual	~MirFreqSetup ()
casacore::Bool	operator== (MirFreqSetup &that)
	return true if this setup is the same as another. More...
casacore::Bool	operator!= (MirFreqSetup &that)
	return false if this setup is the same as another. More...
void	clear ()
	clear the id and index maps More...
MirFreqSetup *	findIn (casacore::List< MirFreqSetup * > &setuplist)
	return a pointer to a setup in a given list of setups that is equal to this setup. More...
Public Member Functions inherited from MirInfo
	MirInfo ()
virtual	~MirInfo ()

Static Public Member Functions
static void	clearIDs (casacore::List< MirFreqSetup * > &setuplist)
	clear the ID values for all the setups in a setup list by setting them to -1. More...

Public Attributes
casacore::Int	mode
	the correlator mode More...
casacore::Float *	corbw
	the correlator filter bandwidths More...
casacore::Float *	corf
	the correlator LO frequencies More...
casacore::Int	nspect
	the number of spectral windows More...
casacore::Int	nwide
	the number of wideband channels More...
casacore::Int	nchan
	the total number of spectral line channels More...
casacore::Int *	nschan
	the number of channels in each window More...
casacore::Int *	ischan
	the number of the first channel in each window More...
casacore::Double *	sfreq
	the frequency of the first channel in each window More...
casacore::Double *	sdf
	the frequency separation between channels in each window More...
casacore::Double *	rfreq
	the rest frequency for each window More...
casacore::Float *	wfreq
	the center frequency of each wideband channel More...
casacore::Float *	wwidth
	the bandwidth of each wideband channel More...
casacore::Double	freq
	the reference frequency for this setup. More...
casacore::Int	id
	the ID assigned to this setup within the casacore::MeasurementSet being filled. More...
IDIndex	nfidx
	the narrow window mapping index. More...
IDIndex	wfidx
	the wideband mapping index. More...

Detailed Description

A description of a Miriad spectroscopy (correlator) setup.

Intended use:

Internal

Review Status

Date Reviewed:

yyyy/mm/dd

Etymology

a description of the frequency setup used by a Miriad dataset

Synopsis

This class contains the data describing the frequency domain of a portion of the dataset.

Most of the interaction with this class is through public data members (for programming and runtime efficiency); thus, this class is not appropriate for use outside of this module. A few helper funtions are provided to aid in utilizing the information (mainly for comparison with other MirFreqSetup objects).

Motivation

a Miriad dataset may switch back and forth between different correlator configurations. The filler must keep track of them, and recognize them when the are reused.

Definition at line 185 of file FillMetadata.h.

Constructor & Destructor Documentation

MirFreqSetup::MirFreqSetup

(

casacore::Int

mir_handle

)

create a new setup by reading the relevent variable data from the given miriad dataset handle

virtual MirFreqSetup::~MirFreqSetup ( )

virtual

Member Function Documentation

void MirFreqSetup::clear ( )

inline

clear the id and index maps

Definition at line 262 of file FillMetadata.h.

References IDIndex::clear(), nfidx, and wfidx.

static void MirFreqSetup::clearIDs ( casacore::List< MirFreqSetup * > &  setuplist )

inlinestatic

clear the ID values for all the setups in a setup list by setting them to -1.

Definition at line 278 of file FillMetadata.h.

References casacore::ConstListIter< t >::atEnd().

MirFreqSetup* MirFreqSetup::findIn ( casacore::List< MirFreqSetup * > &  setuplist )

inline

return a pointer to a setup in a given list of setups that is equal to this setup.

Definition at line 270 of file FillMetadata.h.

References casacore::ConstListIter< t >::atEnd(), and casacore::ListIter< t >::getRight().

casacore::Bool MirFreqSetup::operator!= ( MirFreqSetup &  that )

inline

return false if this setup is the same as another.

Definition at line 257 of file FillMetadata.h.

casacore::Bool MirFreqSetup::operator==

(

MirFreqSetup &

that

)

return true if this setup is the same as another.

Two setups will be considered equal if the mode, nwide, nspect, corfs and corbws are identical. (The window starting frequencies can change as they are topocentric; this may cause problems for miriad data that did not originate from BIMA.)

Member Data Documentation

casacore::Float* MirFreqSetup::corbw

the correlator filter bandwidths

Definition at line 192 of file FillMetadata.h.

casacore::Float* MirFreqSetup::corf

the correlator LO frequencies

Definition at line 195 of file FillMetadata.h.

casacore::Double MirFreqSetup::freq

the reference frequency for this setup.

Usually the rest frequency of the primary line of the observations.

Definition at line 229 of file FillMetadata.h.

casacore::Int MirFreqSetup::id

the ID assigned to this setup within the casacore::MeasurementSet being filled.

A value of -1 means that the ID has not yet been assigned.

Definition at line 233 of file FillMetadata.h.

casacore::Int* MirFreqSetup::ischan

the number of the first channel in each window

Definition at line 210 of file FillMetadata.h.

casacore::Int MirFreqSetup::mode

the correlator mode

Definition at line 189 of file FillMetadata.h.

casacore::Int MirFreqSetup::nchan

the total number of spectral line channels

Definition at line 204 of file FillMetadata.h.

IDIndex MirFreqSetup::nfidx

the narrow window mapping index.

This maps Miriad window numbers to casacore::MS spectral window IDs.

Definition at line 237 of file FillMetadata.h.

Referenced by clear().

casacore::Int* MirFreqSetup::nschan

the number of channels in each window

Definition at line 207 of file FillMetadata.h.

casacore::Int MirFreqSetup::nspect

the number of spectral windows

Definition at line 198 of file FillMetadata.h.

casacore::Int MirFreqSetup::nwide

the number of wideband channels

Definition at line 201 of file FillMetadata.h.

casacore::Double* MirFreqSetup::rfreq

the rest frequency for each window

Definition at line 219 of file FillMetadata.h.

casacore::Double* MirFreqSetup::sdf

the frequency separation between channels in each window

Definition at line 216 of file FillMetadata.h.

casacore::Double* MirFreqSetup::sfreq

the frequency of the first channel in each window

Definition at line 213 of file FillMetadata.h.

IDIndex MirFreqSetup::wfidx

the wideband mapping index.

This maps Miriad wideband channel numbers to casacore::MS spectral window IDs.

Definition at line 241 of file FillMetadata.h.

Referenced by clear().

casacore::Float* MirFreqSetup::wfreq

the center frequency of each wideband channel

Definition at line 222 of file FillMetadata.h.

casacore::Float* MirFreqSetup::wwidth

the bandwidth of each wideband channel

Definition at line 225 of file FillMetadata.h.

---

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

• casa/code/miriad/Filling/FillMetadata.h