MirFreqSetup Class Reference

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

#include <FillMetadata.h>

Inheritance diagram for MirFreqSetup:

Public Member Functions
	MirFreqSetup (Int mir_handle)
	create a new setup by reading the relevent variable data from the given miriad dataset handle
virtual	~MirFreqSetup ()
Bool	operator== (MirFreqSetup &that)
	return true if this setup is the same as another.
Bool	operator!= (MirFreqSetup &that)
	return false if this setup is the same as another.
void	clear ()
	clear the id and index maps
MirFreqSetup *	findIn (List< MirFreqSetup * > &setuplist)
	return a pointer to a setup in a given list of setups that is equal to this setup.
Static Public Member Functions
static void	clearIDs (List< MirFreqSetup * > &setuplist)
	clear the ID values for all the setups in a setup list by setting them to -1.
Public Attributes
Int	mode
	the correlator mode
Float *	corbw
	the correlator filter bandwidths
Float *	corf
	the correlator LO frequencies
Int	nspect
	the number of spectral windows
Int	nwide
	the number of wideband channels
Int	nchan
	the total number of spectral line channels
Int *	nschan
	the number of channels in each window
Int *	ischan
	the number of the first channel in each window
Double *	sfreq
	the frequency of the first channel in each window
Double *	sdf
	the frequency separation between channels in each window
Double *	rfreq
	the rest frequency for each window
Float *	wfreq
	the center frequency of each wideband channel
Float *	wwidth
	the bandwidth of each wideband channel
Double	freq
	the reference frequency for this setup.
Int	id
	the ID assigned to this setup within the MeasurementSet being filled.
IDIndex	nfidx
	the narrow window mapping index.
IDIndex	wfidx
	the wideband mapping index.

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 184 of file FillMetadata.h.

Constructor & Destructor Documentation

MirFreqSetup::MirFreqSetup ( 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 261 of file FillMetadata.h.

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

static void MirFreqSetup::clearIDs ( List< MirFreqSetup * > & setuplist ) [inline, static]

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

Definition at line 277 of file FillMetadata.h.

MirFreqSetup* MirFreqSetup::findIn ( 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 269 of file FillMetadata.h.

Bool MirFreqSetup::operator!= ( MirFreqSetup & that ) [inline]

return false if this setup is the same as another.

Definition at line 256 of file FillMetadata.h.

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.)