This class holds the various fill options set through the filler DO. More...

#include <GBTMSFillOptions.h>

Public Member Functions
	GBTMSFillOptions ()
	initialized with the default values for each option
	GBTMSFillOptions (const GBTMSFillOptions &other)
	copy constructor - copy semantics
	~GBTMSFillOptions ()
GBTMSFillOptions &	operator= (const GBTMSFillOptions &other)
	Assignment operator, copy semantics.
Bool	fillRawPointing () const
	The following are used by all backend fillers.
void	setFillRawPointing (Bool fillRawPointing)
	Set the fillRawPointing option.
Bool	fillRawFocus () const
	Fill the raw focus values to the appropriate sub-table?
void	setFillRawFocus (Bool fillRawFocus)
	Set the fillRawFocus option.
Bool	useHighCal () const
	Which CAL_TEMP to use when filling TCAL, LOW or HIGH? Eventually this will be handled through the IF file and these two methods will be eliminated.
void	setUseHighCal (Bool useHighCal)
	Set the useHighCal option.
Bool	compressCalCols () const
	Compress the calibration columns.
void	setCompressCalCols (Bool compressCalCols)
	Set the flag to control whether calibration columns are compressed.
Bool	fillLags () const
	The following options only apply to the ACS.
void	setFillLags (Bool fillLags)
	Set the fillLags option.
GBTACSTable::VanVleckCorr	vanVleckCorr () const
	The vanVleck correction to use.
void	setVanVleckCorr (GBTACSTable::VanVleckCorr vvCorr)
	Set the vanVleck correction to use.
String	vanVleckCorrString () const
	The vanVleck correction to use, as a string.
Bool	setVanVleckCorr (const String &vanVleckCorr)
	Set the vanVleck correction from a string, returns False if the value is unrecognized and sets the vanVleck correction type to the default.
GBTACSTable::Smoothing	smoothing () const
	The smoothing (windowing) to apply to the corrected data prior to fourier transforming the data to the spectral domain.
void	setSmoothing (GBTACSTable::Smoothing smoothing)
	Set the smoothing (windowing) function to use.
String	smoothingString () const
	The smoothing type as a string.
Bool	setSmoothing (const String &smoothing)
	Set the smoothing correction from a string, returns False if The value is unrecognized and set the vanVleck correction type to the default.
Int	vvSize () const
	Get the vv table size for the schwab correction.
Bool	setvvSize (const Int vvsize)
	Set the vv table size for the schwab correction - must be an odd number.
void	setUseBias (Bool usebias)
	Use a derived bias approximation in the van Vleck correction (Schwab correction only)
Bool	useBias () const
	Get the boolean that signals whether or not the bias should be used.
void	setOneacsms (Bool oneacsms)
	Set to fill multi bank ACS data to a single MS.
Bool	oneacsms () const
	Should the filler fill multi bank ACS data to a single MS.
Bool	setDCBias (Double dcbias)
	Set a specific dcbias to use.
Double	dcbias () const
	Returns the specific dcbias to use.
Bool	setMinbiasfactor (Int minbiasfactor)
	Set a minimum bias factor to subtract from the lags.
Int	minbiasfactor () const
	The minimum bias factor to subtract (actual may be larger).
void	setFixbadlags (Bool fixbadlags)
	Toggle correcting for offset ACS lags.
Bool	fixbadlags () const
	Should the ACS lags be fixed if possible.
void	setSigmaFactor (Double sigmafactor)
	Set the sigma factor used when fixbadlags() is True.
Double	sigmaFactor () const
	What is the value of the sigma factor used when fixbadlags() is True.
void	setSpikeStart (Int spikestart)
	Set the starting lag for spike fixing, used when fixbadlags() is True.
Int	spikeStart () const
	What is the value of the spike starting location.
Private Attributes
Bool	itsLags

Bool	itsRawFocus
Bool	itsRawPointing
Bool	itsUseHighCal
Bool	itsCompressCalCols
Bool	itsUseBias
Bool	itsOneacsms
Bool	itsFixbadlags
Int	itsVVsize
Int	itsMinbiasfactor
Int	itsSpikeStart
Double	itsDCBias
Double	itsSigmaFactor
GBTACSTable::VanVleckCorr	itsVVCorr
GBTACSTable::Smoothing	itsSmooth

Detailed Description

This class holds the various fill options set through the filler DO.

Intended use:

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

gbtmsfiller distributed object

Etymology

This holds the options for the gbtmsfiller DO.

Synopsis

Example

Motivation

Some options are common to all backends while others only apply to one backend. By putting the options here, an instance of this class can be passed to each filler via the fill command so that each backend filler doesn't need to know about options that don't affect it and the fill arguments don't need to be changed for each backend whenever a particular filler needs a new option.

To Do

Everything

Definition at line 75 of file GBTMSFillOptions.h.

Constructor & Destructor Documentation

GBTMSFillOptions::GBTMSFillOptions ( )

initialized with the default values for each option

GBTMSFillOptions::GBTMSFillOptions ( const GBTMSFillOptions & other )

copy constructor - copy semantics

GBTMSFillOptions::~GBTMSFillOptions ( ) [inline]

Definition at line 84 of file GBTMSFillOptions.h.

Member Function Documentation

Bool GBTMSFillOptions::compressCalCols ( ) const [inline]

Compress the calibration columns.

Definition at line 111 of file GBTMSFillOptions.h.

References itsCompressCalCols.

Referenced by setCompressCalCols().

Double GBTMSFillOptions::dcbias ( ) const [inline]

Returns the specific dcbias to use.

Ignored if usebias is True.

Definition at line 162 of file GBTMSFillOptions.h.

References itsDCBias.

Referenced by setDCBias().

Bool GBTMSFillOptions::fillLags ( ) const [inline]

The following options only apply to the ACS.

Fill the LAGS in addition to FLOAT_DATA?

Definition at line 120 of file GBTMSFillOptions.h.

References itsLags.

Referenced by setFillLags().

Bool GBTMSFillOptions::fillRawFocus ( ) const [inline]

Fill the raw focus values to the appropriate sub-table?

Definition at line 97 of file GBTMSFillOptions.h.

References itsRawFocus.

Referenced by setFillRawFocus().

Bool GBTMSFillOptions::fillRawPointing ( ) const [inline]

The following are used by all backend fillers.

Fill the raw pointing values to the appropriate sub-table?

Definition at line 92 of file GBTMSFillOptions.h.

References itsRawPointing.

Referenced by setFillRawPointing().

Bool GBTMSFillOptions::fixbadlags ( ) const [inline]

Should the ACS lags be fixed if possible.

Definition at line 170 of file GBTMSFillOptions.h.

References itsFixbadlags.

Referenced by setFixbadlags().

Int GBTMSFillOptions::minbiasfactor ( ) const [inline]

The minimum bias factor to subtract (actual may be larger).

If < 0, nothing is subtracted from the lags.

Definition at line 166 of file GBTMSFillOptions.h.

References itsMinbiasfactor.

Referenced by setMinbiasfactor().

Bool GBTMSFillOptions::oneacsms ( ) const [inline]

Should the filler fill multi bank ACS data to a single MS.

Definition at line 158 of file GBTMSFillOptions.h.

References itsOneacsms.

Referenced by setOneacsms().

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

Assignment operator, copy semantics.

void GBTMSFillOptions::setCompressCalCols ( Bool compressCalCols ) [inline]

Set the flag to control whether calibration columns are compressed.

Definition at line 113 of file GBTMSFillOptions.h.

References compressCalCols(), and itsCompressCalCols.

Bool GBTMSFillOptions::setDCBias ( Double dcbias ) [inline]

Set a specific dcbias to use.

Definition at line 160 of file GBTMSFillOptions.h.

References dcbias(), itsDCBias, and casa::True.

void GBTMSFillOptions::setFillLags ( Bool fillLags ) [inline]

Set the fillLags option.

Definition at line 122 of file GBTMSFillOptions.h.

References fillLags(), and itsLags.

void GBTMSFillOptions::setFillRawFocus ( Bool fillRawFocus ) [inline]

Set the fillRawFocus option.

Definition at line 99 of file GBTMSFillOptions.h.

References fillRawFocus(), and itsRawFocus.

void GBTMSFillOptions::setFillRawPointing ( Bool fillRawPointing ) [inline]

Set the fillRawPointing option.

Definition at line 94 of file GBTMSFillOptions.h.

References fillRawPointing(), and itsRawPointing.

void GBTMSFillOptions::setFixbadlags ( Bool fixbadlags ) [inline]

Toggle correcting for offset ACS lags.

Definition at line 168 of file GBTMSFillOptions.h.

References fixbadlags(), and itsFixbadlags.

Bool GBTMSFillOptions::setMinbiasfactor ( Int minbiasfactor ) [inline]

Set a minimum bias factor to subtract from the lags.

Definition at line 164 of file GBTMSFillOptions.h.

References itsMinbiasfactor, minbiasfactor(), and casa::True.

void GBTMSFillOptions::setOneacsms ( Bool oneacsms ) [inline]

Set to fill multi bank ACS data to a single MS.

Definition at line 156 of file GBTMSFillOptions.h.

References itsOneacsms, and oneacsms().

void GBTMSFillOptions::setSigmaFactor ( Double sigmafactor ) [inline]

Set the sigma factor used when fixbadlags() is True.

Definition at line 172 of file GBTMSFillOptions.h.

References itsSigmaFactor.

void GBTMSFillOptions::setSmoothing ( GBTACSTable::Smoothing smoothing ) [inline]

Set the smoothing (windowing) function to use.

Definition at line 137 of file GBTMSFillOptions.h.

References itsSmooth, and smoothing().

Bool GBTMSFillOptions::setSmoothing ( const String & smoothing )

Set the smoothing correction from a string, returns False if The value is unrecognized and set the vanVleck correction type to the default.

void GBTMSFillOptions::setSpikeStart ( Int spikestart ) [inline]

Set the starting lag for spike fixing, used when fixbadlags() is True.

Definition at line 176 of file GBTMSFillOptions.h.

References itsSpikeStart.

void GBTMSFillOptions::setUseBias ( Bool usebias ) [inline]

Use a derived bias approximation in the van Vleck correction (Schwab correction only)

Definition at line 152 of file GBTMSFillOptions.h.

References itsUseBias.

void GBTMSFillOptions::setUseHighCal ( Bool useHighCal ) [inline]

Set the useHighCal option.

This can be used to override the default behavior of using LOW_CAL_TEMP.

Definition at line 108 of file GBTMSFillOptions.h.

References itsUseHighCal, and useHighCal().

void GBTMSFillOptions::setVanVleckCorr ( GBTACSTable::VanVleckCorr vvCorr ) [inline]

Set the vanVleck correction to use.

Definition at line 126 of file GBTMSFillOptions.h.

References itsVVCorr.

Bool GBTMSFillOptions::setVanVleckCorr ( const String & vanVleckCorr )

Set the vanVleck correction from a string, returns False if the value is unrecognized and sets the vanVleck correction type to the default.

Bool GBTMSFillOptions::setvvSize ( const Int vvsize )

Set the vv table size for the schwab correction - must be an odd number.

Double GBTMSFillOptions::sigmaFactor ( ) const [inline]

What is the value of the sigma factor used when fixbadlags() is True.

Definition at line 174 of file GBTMSFillOptions.h.

References itsSigmaFactor.

GBTACSTable::Smoothing GBTMSFillOptions::smoothing ( ) const [inline]

The smoothing (windowing) to apply to the corrected data prior to fourier transforming the data to the spectral domain.

Definition at line 135 of file GBTMSFillOptions.h.

References itsSmooth.

Referenced by setSmoothing().

String GBTMSFillOptions::smoothingString ( ) const

The smoothing type as a string.

Int GBTMSFillOptions::spikeStart ( ) const [inline]

What is the value of the spike starting location.

Definition at line 178 of file GBTMSFillOptions.h.

References itsSpikeStart.

Bool GBTMSFillOptions::useBias ( ) const [inline]

Get the boolean that signals whether or not the bias should be used.

Definition at line 154 of file GBTMSFillOptions.h.

References itsUseBias.

Bool GBTMSFillOptions::useHighCal ( ) const [inline]

Which CAL_TEMP to use when filling TCAL, LOW or HIGH? Eventually this will be handled through the IF file and these two methods will be eliminated.

If this returns True, then the HIGH cal will be used, otherwise the LOW cal is used.

Definition at line 105 of file GBTMSFillOptions.h.

References itsUseHighCal.

Referenced by setUseHighCal().

GBTACSTable::VanVleckCorr GBTMSFillOptions::vanVleckCorr ( ) const [inline]

The vanVleck correction to use.

Definition at line 124 of file GBTMSFillOptions.h.

References itsVVCorr.

String GBTMSFillOptions::vanVleckCorrString ( ) const

The vanVleck correction to use, as a string.

Int GBTMSFillOptions::vvSize ( ) const [inline]

Get the vv table size for the schwab correction.

Definition at line 146 of file GBTMSFillOptions.h.

References itsVVsize.

Member Data Documentation

Bool GBTMSFillOptions::itsCompressCalCols [private]

Definition at line 182 of file GBTMSFillOptions.h.

Referenced by compressCalCols(), and setCompressCalCols().

Double GBTMSFillOptions::itsDCBias [private]

Definition at line 185 of file GBTMSFillOptions.h.

Referenced by dcbias(), and setDCBias().

Bool GBTMSFillOptions::itsFixbadlags [private]

Definition at line 182 of file GBTMSFillOptions.h.

Referenced by fixbadlags(), and setFixbadlags().

Bool GBTMSFillOptions::itsLags [private]

Definition at line 182 of file GBTMSFillOptions.h.

Referenced by fillLags(), and setFillLags().

Int GBTMSFillOptions::itsMinbiasfactor [private]

Definition at line 184 of file GBTMSFillOptions.h.

Referenced by minbiasfactor(), and setMinbiasfactor().

Bool GBTMSFillOptions::itsOneacsms [private]

Definition at line 182 of file GBTMSFillOptions.h.

Referenced by oneacsms(), and setOneacsms().

Bool GBTMSFillOptions::itsRawFocus [private]

Definition at line 182 of file GBTMSFillOptions.h.

Referenced by fillRawFocus(), and setFillRawFocus().

Bool GBTMSFillOptions::itsRawPointing [private]

Definition at line 182 of file GBTMSFillOptions.h.

Referenced by fillRawPointing(), and setFillRawPointing().

Double GBTMSFillOptions::itsSigmaFactor [private]

Definition at line 185 of file GBTMSFillOptions.h.

Referenced by setSigmaFactor(), and sigmaFactor().

GBTACSTable::Smoothing GBTMSFillOptions::itsSmooth [private]

Definition at line 188 of file GBTMSFillOptions.h.

Referenced by setSmoothing(), and smoothing().

Int GBTMSFillOptions::itsSpikeStart [private]

Definition at line 184 of file GBTMSFillOptions.h.

Referenced by setSpikeStart(), and spikeStart().

Bool GBTMSFillOptions::itsUseBias [private]

Definition at line 182 of file GBTMSFillOptions.h.

Referenced by setUseBias(), and useBias().

Bool GBTMSFillOptions::itsUseHighCal [private]

Definition at line 182 of file GBTMSFillOptions.h.

Referenced by setUseHighCal(), and useHighCal().

GBTACSTable::VanVleckCorr GBTMSFillOptions::itsVVCorr [private]

Definition at line 187 of file GBTMSFillOptions.h.

Referenced by setVanVleckCorr(), and vanVleckCorr().

Int GBTMSFillOptions::itsVVsize [private]

Definition at line 184 of file GBTMSFillOptions.h.

Referenced by vvSize().

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

code/nrao/GBTFillers/GBTMSFillOptions.h

Public Member Functions

Private Attributes

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

To Do

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation