casa::PlotMSTransformations Class Reference

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 //. More...
veldef	PlotMSTransformations ()
	Non-Static //. More...
	~PlotMSTransformations ()
	Destructor. More...
void	fromRecord (const casacore::RecordInterface &record)
	Converts this object to/from a record. More...
casacore::Record	toRecord () const
casacore::Bool	anyTransform () const
	If any transformations are specified, return true. More...
casacore::MFrequency::Types	frame ()
	Convenience methods for returning the standard field values. More...
casacore::MDoppler::Types	veldef ()
casacore::String	frameStr () const
casacore::String	veldefStr () const
casacore::Double	restFreq () const
casacore::Double	restFreqHz () const
casacore::Double	xpcOffset () const
casacore::Double	ypcOffset () const
casacore::Bool	formStokes () const
void	setFrame (casacore::MFrequency::Types type)
	Convenience methods for setting the standard field values. More...
void	setFrame (const casacore::String &typeStr)
void	setVelDef (casacore::MDoppler::Types type)
void	setVelDef (const casacore::String &typeStr)
void	setRestFreq (casacore::Double restfreq)
void	setRestFreq (casacore::Quantity restfreq)
void	setXpcOffset (casacore::Double dx)
void	setYpcOffset (casacore::Double dy)
void	setFormStokes (casacore::Bool formstokes)
bool	operator== (const PlotMSTransformations &other) const
	Equality operators. More...
bool	operator!= (const PlotMSTransformations &other) const
casacore::String	summary () const
	Print out a summary. More...

Public Attributes
	fields
	fieldStrings
	field
	Frame

Private Member Functions
void	setDefaults ()
	Sets the default values. More...

Private Attributes
casacore::MFrequency::Types	mfreqType_
	The Frequency frame. More...
casacore::MDoppler::Types	mdoppType_
	The Velocity Defn. More...
casacore::Double	restFreq_
	The rest frequency (MHz) More...
casacore::Double	XpcOffset_
	Phase center offsets. More...
casacore::Double	YpcOffset_
casacore::Bool	formStokes_
	Form casacore::Stokes from correlations. More...

Detailed Description

Specifies averaging parameters for an MS.

Definition at line 38 of file PlotMSTransformations.h.

Constructor & Destructor Documentation

veldef casa::PlotMSTransformations::PlotMSTransformations

(

)

Non-Static //.

Constructor, which uses default values.

casa::PlotMSTransformations::~PlotMSTransformations

(

)

Destructor.

Member Function Documentation

casacore::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().

casacore::Bool casa::PlotMSTransformations::formStokes ( ) const

inline

Definition at line 85 of file PlotMSTransformations.h.

References formStokes_.

Referenced by anyTransform().

casacore::MFrequency::Types casa::PlotMSTransformations::frame ( )

inline

Convenience methods for returning the standard field values.

Definition at line 76 of file PlotMSTransformations.h.

References mfreqType_.

casacore::String casa::PlotMSTransformations::frameStr ( ) const

inline

Definition at line 78 of file PlotMSTransformations.h.

References mfreqType_, casacore::MFrequency::N_Types, and casacore::MFrequency::showType().

Referenced by anyTransform().

void casa::PlotMSTransformations::fromRecord

(

const casacore::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 casacore::MS averaging.

casacore::Double casa::PlotMSTransformations::restFreq ( ) const

inline

Definition at line 81 of file PlotMSTransformations.h.

References restFreq_.

casacore::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 ( casacore::Bool  formstokes )

inline

Definition at line 102 of file PlotMSTransformations.h.

References formStokes_.

void casa::PlotMSTransformations::setFrame ( casacore::MFrequency::Types  type )

inline

Convenience methods for setting the standard field values.

Definition at line 92 of file PlotMSTransformations.h.

References mfreqType_, and casa::type().

void casa::PlotMSTransformations::setFrame ( const casacore::String &  typeStr )

inline

Definition at line 93 of file PlotMSTransformations.h.

References casacore::MFrequency::getType(), mfreqType_, and casacore::MFrequency::N_Types.

void casa::PlotMSTransformations::setRestFreq ( casacore::Double  restfreq )

inline

Definition at line 98 of file PlotMSTransformations.h.

References restFreq_.

void casa::PlotMSTransformations::setRestFreq ( casacore::Quantity  restfreq )

inline

Definition at line 99 of file PlotMSTransformations.h.

References casacore::Quantum< Qtype >::getValue(), and restFreq_.

void casa::PlotMSTransformations::setVelDef ( casacore::MDoppler::Types  type )

inline

Definition at line 96 of file PlotMSTransformations.h.

References mdoppType_, and casa::type().

void casa::PlotMSTransformations::setVelDef ( const casacore::String &  typeStr )

inline

Definition at line 97 of file PlotMSTransformations.h.

References casacore::MDoppler::getType(), and mdoppType_.

void casa::PlotMSTransformations::setXpcOffset ( casacore::Double  dx )

inline

Definition at line 100 of file PlotMSTransformations.h.

References XpcOffset_.

void casa::PlotMSTransformations::setYpcOffset ( casacore::Double  dy )

inline

Definition at line 101 of file PlotMSTransformations.h.

References YpcOffset_.

casacore::String casa::PlotMSTransformations::summary

(

)

const

Print out a summary.

casacore::Record casa::PlotMSTransformations::toRecord

(

)

const

casacore::MDoppler::Types casa::PlotMSTransformations::veldef ( )

inline

Definition at line 77 of file PlotMSTransformations.h.

References mdoppType_.

casacore::String casa::PlotMSTransformations::veldefStr ( ) const

inline

Definition at line 80 of file PlotMSTransformations.h.

References mdoppType_, and casacore::MDoppler::showType().

Referenced by anyTransform().

casacore::Double casa::PlotMSTransformations::xpcOffset ( ) const

inline

Definition at line 83 of file PlotMSTransformations.h.

References XpcOffset_.

Referenced by anyTransform().

casacore::Double casa::PlotMSTransformations::ypcOffset ( ) const

inline

Definition at line 84 of file PlotMSTransformations.h.

References YpcOffset_.

Referenced by anyTransform().

Member Data Documentation

casa::PlotMSTransformations::field

Definition at line 46 of file PlotMSTransformations.h.

casa::PlotMSTransformations::fields

Definition at line 46 of file PlotMSTransformations.h.

casa::PlotMSTransformations::fieldStrings

Definition at line 46 of file PlotMSTransformations.h.

casacore::Bool casa::PlotMSTransformations::formStokes_

private

Form casacore::Stokes from correlations.

Definition at line 131 of file PlotMSTransformations.h.

Referenced by formStokes(), and setFormStokes().

casa::PlotMSTransformations::Frame

Definition at line 46 of file PlotMSTransformations.h.

casacore::MDoppler::Types casa::PlotMSTransformations::mdoppType_

private

The Velocity Defn.

Definition at line 122 of file PlotMSTransformations.h.

Referenced by setVelDef(), veldef(), and veldefStr().

casacore::MFrequency::Types casa::PlotMSTransformations::mfreqType_

private

The Frequency frame.

Definition at line 119 of file PlotMSTransformations.h.

Referenced by frame(), frameStr(), and setFrame().

casacore::Double casa::PlotMSTransformations::restFreq_

private

The rest frequency (MHz)

Definition at line 125 of file PlotMSTransformations.h.

Referenced by restFreq(), restFreqHz(), and setRestFreq().

casacore::Double casa::PlotMSTransformations::XpcOffset_

private

Phase center offsets.

Definition at line 128 of file PlotMSTransformations.h.

Referenced by setXpcOffset(), and xpcOffset().

casacore::Double casa::PlotMSTransformations::YpcOffset_

private

Definition at line 128 of file PlotMSTransformations.h.

Referenced by setYpcOffset(), and ypcOffset().

---

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

• casa/code/plotms/PlotMS/PlotMSTransformations.h