GBTMSFillOptions.h

Classes

GBTMSFillOptions -- This class holds the various fill options set through the filler DO (full description)

class GBTMSFillOptions

Interface

Public Members

GBTMSFillOptions()

GBTMSFillOptions(const GBTMSFillOptions &other)

~GBTMSFillOptions()

GBTMSFillOptions &operator=(const GBTMSFillOptions &other)

Bool fillRawPointing() const

void setFillRawPointing(Bool fillRawPointing)

Bool fillRawFocus() const

void setFillRawFocus(Bool fillRawFocus)

Bool useHighCal() const

void setUseHighCal(Bool useHighCal)

Bool compressCalCols() const

void setCompressCalCols(Bool compressCalCols)

Bool fillLags() const

void setFillLags(Bool fillLags)

GBTACSTable::VanVleckCorr vanVleckCorr() const

void setVanVleckCorr(GBTACSTable::VanVleckCorr vvCorr)

String vanVleckCorrString() const

Bool setVanVleckCorr(const String &vanVleckCorr)

GBTACSTable::Smoothing smoothing() const

void setSmoothing(GBTACSTable::Smoothing smoothing)

String smoothingString() const

Bool setSmoothing(const String &smoothing)

Int vvSize() const

Bool setvvSize(const Int vvsize)

void setUseBias(Bool usebias)

Bool useBias() const

void setOneacsms(Bool oneacsms)

Bool oneacsms() const

Bool setDCBias(Double dcbias)

Double dcbias() const

Bool setMinbiasfactor(Int minbiasfactor)

Int minbiasfactor() const

void setFixbadlags(Bool fixbadlags)

Bool fixbadlags() const

void setSigmaFactor(Double sigmafactor)

Double sigmaFactor() const

void setSpikeStart(Int spikestart)

Int spikeStart() const

Description

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

Member Description

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

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

void setFillRawPointing(Bool fillRawPointing)

The following are used by all backend fillers

Set the fillRawPointing option

Bool fillRawFocus() const

The following are used by all backend fillers

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

void setFillRawFocus(Bool fillRawFocus)

The following are used by all backend fillers

Set the fillRawFocus option

Bool useHighCal() const

The following are used by all backend fillers

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.

void setUseHighCal(Bool useHighCal)

The following are used by all backend fillers

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

Bool compressCalCols() const

The following are used by all backend fillers

Compress the calibration columns.

void setCompressCalCols(Bool compressCalCols)

The following are used by all backend fillers

Set the flag to control whether calibration columns are compressed.

void setFillLags(Bool fillLags)

The following options only apply to the ACS

Set the fillLags option

GBTACSTable::VanVleckCorr vanVleckCorr() const

The following options only apply to the ACS

The vanVleck correction to use

void setVanVleckCorr(GBTACSTable::VanVleckCorr vvCorr)

The following options only apply to the ACS

Set the vanVleck correction to use

String vanVleckCorrString() const

The following options only apply to the ACS

The vanVleck correction to use, as a string

Bool setVanVleckCorr(const String &vanVleckCorr)

The following options only apply to the ACS

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 following options only apply to the ACS

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

void setSmoothing(GBTACSTable::Smoothing smoothing)

The following options only apply to the ACS

Set the smoothing (windowing) function to use

String smoothingString() const

The following options only apply to the ACS

The smoothing type as a string

Bool setSmoothing(const String &smoothing)

The following options only apply to the ACS

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

The following options only apply to the ACS

Get the vv table size for the schwab correction

Bool setvvSize(const Int vvsize)

The following options only apply to the ACS

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

void setUseBias(Bool usebias)

The following options only apply to the ACS

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

Bool useBias() const

The following options only apply to the ACS

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

void setOneacsms(Bool oneacsms)

The following options only apply to the ACS

Set to fill multi bank ACS data to a single MS

Bool oneacsms() const

The following options only apply to the ACS

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

Bool setDCBias(Double dcbias)

The following options only apply to the ACS

Set a specific dcbias to use.

Double dcbias() const

The following options only apply to the ACS

Returns the specific dcbias to use. Ignored if usebias is True.

Bool setMinbiasfactor(Int minbiasfactor)

The following options only apply to the ACS

Set a minimum bias factor to subtract from the lags.

Int minbiasfactor() const

The following options only apply to the ACS

The minimum bias factor to subtract (actual may be larger). If < 0, nothing is subtracted from the lags.

void setFixbadlags(Bool fixbadlags)

The following options only apply to the ACS

Toggle correcting for offset ACS lags

Bool fixbadlags() const

The following options only apply to the ACS

Should the ACS lags be fixed if possible

void setSigmaFactor(Double sigmafactor)

The following options only apply to the ACS

Set the sigma factor used when fixbadlags() is True

Double sigmaFactor() const

The following options only apply to the ACS

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

void setSpikeStart(Int spikestart)

The following options only apply to the ACS

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

Int spikeStart() const

The following options only apply to the ACS

What is the value of the spike starting location

Bool fillLags() const

The following options only apply to the ACS