Specifies averaging parameters for an MS. More...
#include <PlotMSTransformations.h>
Public Member Functions | |
PMS_ENUM1 (Field, fields, fieldStrings, field, FRAME, VELDEF) PMS_ENUM2(Field | |
Static //. | |
veldef | PlotMSTransformations () |
Non-Static //. | |
~PlotMSTransformations () | |
Destructor. | |
void | fromRecord (const RecordInterface &record) |
Converts this object to/from a record. | |
Record | toRecord () const |
Bool | anyTransform () const |
If any transformations are specified, return True. | |
MFrequency::Types | frame () |
Convenience methods for returning the standard field values. | |
MDoppler::Types | veldef () |
String | frameStr () const |
String | veldefStr () const |
Double | restFreq () const |
Double | restFreqHz () const |
Double | xpcOffset () const |
Double | ypcOffset () const |
Bool | formStokes () const |
void | setFrame (MFrequency::Types type) |
Convenience methods for setting the standard field values. | |
void | setFrame (const String &typeStr) |
void | setVelDef (MDoppler::Types type) |
void | setVelDef (const String &typeStr) |
void | setRestFreq (Double restfreq) |
void | setRestFreq (Quantity restfreq) |
void | setXpcOffset (Double dx) |
void | setYpcOffset (Double dy) |
void | setFormStokes (Bool formstokes) |
bool | operator== (const PlotMSTransformations &other) const |
Equality operators. | |
bool | operator!= (const PlotMSTransformations &other) const |
String | summary () const |
Print out a summary. | |
Public Attributes | |
fields | |
fieldStrings | |
field | |
Frame | |
Private Member Functions | |
void | setDefaults () |
Sets the default values. | |
Private Attributes | |
MFrequency::Types | mfreqType_ |
The Frequency frame. | |
MDoppler::Types | mdoppType_ |
The Velocity Defn. | |
Double | restFreq_ |
The rest frequency (MHz). | |
Double | XpcOffset_ |
Phase center offsets. | |
Double | YpcOffset_ |
Bool | formStokes_ |
Form Stokes from correlations. |
Specifies averaging parameters for an MS.
Definition at line 38 of file PlotMSTransformations.h.
veldef casa::PlotMSTransformations::PlotMSTransformations | ( | ) |
Non-Static //.
Constructor, which uses default values.
casa::PlotMSTransformations::~PlotMSTransformations | ( | ) |
Destructor.
Bool casa::PlotMSTransformations::anyTransform | ( | ) | const [inline] |
If any transformations are specified, return True.
Definition at line 68 of file PlotMSTransformations.h.
References formStokes(), frameStr(), veldefStr(), xpcOffset(), and ypcOffset().
Bool casa::PlotMSTransformations::formStokes | ( | ) | const [inline] |
Definition at line 85 of file PlotMSTransformations.h.
References formStokes_.
Referenced by anyTransform().
MFrequency::Types casa::PlotMSTransformations::frame | ( | ) | [inline] |
Convenience methods for returning the standard field values.
Definition at line 76 of file PlotMSTransformations.h.
References mfreqType_.
String casa::PlotMSTransformations::frameStr | ( | ) | const [inline] |
Definition at line 78 of file PlotMSTransformations.h.
References mfreqType_.
Referenced by anyTransform().
void casa::PlotMSTransformations::fromRecord | ( | const RecordInterface & | record | ) |
Converts this object to/from a record.
Each field will have a key that is its enum name
bool casa::PlotMSTransformations::operator!= | ( | const PlotMSTransformations & | other | ) | const [inline] |
Definition at line 109 of file PlotMSTransformations.h.
References operator==().
bool casa::PlotMSTransformations::operator== | ( | const PlotMSTransformations & | other | ) | const |
Equality operators.
Referenced by operator!=().
casa::PlotMSTransformations::PMS_ENUM1 | ( | Field | , | |
fields | , | |||
fieldStrings | , | |||
field | , | |||
FRAME | , | |||
VELDEF | ||||
) |
Static //.
Enum and methods to define the different fields for an MS averaging.
Double casa::PlotMSTransformations::restFreq | ( | ) | const [inline] |
Definition at line 81 of file PlotMSTransformations.h.
References restFreq_.
Double casa::PlotMSTransformations::restFreqHz | ( | ) | const [inline] |
Definition at line 82 of file PlotMSTransformations.h.
References restFreq_.
void casa::PlotMSTransformations::setDefaults | ( | ) | [private] |
Sets the default values.
void casa::PlotMSTransformations::setFormStokes | ( | Bool | formstokes | ) | [inline] |
Definition at line 102 of file PlotMSTransformations.h.
References formStokes_.
void casa::PlotMSTransformations::setFrame | ( | const String & | typeStr | ) | [inline] |
Definition at line 93 of file PlotMSTransformations.h.
References mfreqType_.
void casa::PlotMSTransformations::setFrame | ( | MFrequency::Types | type | ) | [inline] |
Convenience methods for setting the standard field values.
Definition at line 92 of file PlotMSTransformations.h.
References mfreqType_.
void casa::PlotMSTransformations::setRestFreq | ( | Quantity | restfreq | ) | [inline] |
Definition at line 99 of file PlotMSTransformations.h.
References restFreq_.
void casa::PlotMSTransformations::setRestFreq | ( | Double | restfreq | ) | [inline] |
Definition at line 98 of file PlotMSTransformations.h.
References restFreq_.
void casa::PlotMSTransformations::setVelDef | ( | const String & | typeStr | ) | [inline] |
Definition at line 97 of file PlotMSTransformations.h.
References mdoppType_.
void casa::PlotMSTransformations::setVelDef | ( | MDoppler::Types | type | ) | [inline] |
Definition at line 96 of file PlotMSTransformations.h.
References mdoppType_.
void casa::PlotMSTransformations::setXpcOffset | ( | Double | dx | ) | [inline] |
Definition at line 100 of file PlotMSTransformations.h.
References XpcOffset_.
void casa::PlotMSTransformations::setYpcOffset | ( | Double | dy | ) | [inline] |
Definition at line 101 of file PlotMSTransformations.h.
References YpcOffset_.
String casa::PlotMSTransformations::summary | ( | ) | const |
Print out a summary.
Record casa::PlotMSTransformations::toRecord | ( | ) | const |
MDoppler::Types casa::PlotMSTransformations::veldef | ( | ) | [inline] |
Definition at line 77 of file PlotMSTransformations.h.
References mdoppType_.
String casa::PlotMSTransformations::veldefStr | ( | ) | const [inline] |
Definition at line 80 of file PlotMSTransformations.h.
References mdoppType_.
Referenced by anyTransform().
Double casa::PlotMSTransformations::xpcOffset | ( | ) | const [inline] |
Definition at line 83 of file PlotMSTransformations.h.
References XpcOffset_.
Referenced by anyTransform().
Double casa::PlotMSTransformations::ypcOffset | ( | ) | const [inline] |
Definition at line 84 of file PlotMSTransformations.h.
References YpcOffset_.
Referenced by anyTransform().
Definition at line 46 of file PlotMSTransformations.h.
Definition at line 46 of file PlotMSTransformations.h.
Definition at line 46 of file PlotMSTransformations.h.
Bool casa::PlotMSTransformations::formStokes_ [private] |
Form Stokes from correlations.
Definition at line 131 of file PlotMSTransformations.h.
Referenced by formStokes(), and setFormStokes().
Definition at line 46 of file PlotMSTransformations.h.
MDoppler::Types casa::PlotMSTransformations::mdoppType_ [private] |
The Velocity Defn.
Definition at line 122 of file PlotMSTransformations.h.
Referenced by setVelDef(), veldef(), and veldefStr().
MFrequency::Types casa::PlotMSTransformations::mfreqType_ [private] |
The Frequency frame.
Definition at line 119 of file PlotMSTransformations.h.
Referenced by frame(), frameStr(), and setFrame().
Double casa::PlotMSTransformations::restFreq_ [private] |
The rest frequency (MHz).
Definition at line 125 of file PlotMSTransformations.h.
Referenced by restFreq(), restFreqHz(), and setRestFreq().
Double casa::PlotMSTransformations::XpcOffset_ [private] |
Phase center offsets.
Definition at line 128 of file PlotMSTransformations.h.
Referenced by setXpcOffset(), and xpcOffset().
Double casa::PlotMSTransformations::YpcOffset_ [private] |
Definition at line 128 of file PlotMSTransformations.h.
Referenced by setYpcOffset(), and ypcOffset().