casa::PlotMSSelection Class Reference

Specifies an MS selection. More...

#include <PlotMSSelection.h>

Public Member Functions
	PMS_ENUM1 (Field, fields, fieldStrings, field, FIELD, SPW, TIMERANGE, UVRANGE, ANTENNA, SCAN, CORR, ARRAY, OBSERVATION, INTENT, FEED, MSSELECT) PMS_ENUM2(Field
	Static //.
	PlotMSSelection ()
	Non-Static //.
	PlotMSSelection (const PlotMSSelection &copy)
	Copy constructor.
	~PlotMSSelection ()
	Destructor.
void	fromRecord (const RecordInterface &record)
	Converts this object to/from a record.
Record	toRecord () const
String	toStringShort () const
	Print out an abbreviated summary of the selection.
void	apply (MeasurementSet &ms, MeasurementSet &selectedMS, Vector< Vector< Slice > > &chansel, Vector< Vector< Slice > > &corrsel)
	Applies this selection using the first MS into the second MS.
void	apply (NewCalTable &ct, NewCalTable &selectedCT, Vector< Vector< Slice > > &chansel, Vector< Vector< Slice > > &corrsel)
	Applies this selection to a NewCaltable.
const String &	getValue (Field f) const
	Gets/Sets the value for the given selection field.
void	getValue (Field f, String &value) const
void	setValue (Field f, const String &value)
const String &	field () const
	Convenience methods for returning the standard selection fields.
const String &	spw () const
const String &	timerange () const
const String &	uvrange () const
const String &	antenna () const
const String &	scan () const
const String &	corr () const
const String &	array () const
const String &	observation () const
const String &	intent () const
const String &	feed () const
const String &	msselect () const
const Int &	forceNew () const
void	setField (const String &v)
	Convenience methods for setting the standard selection fields.
void	setSpw (const String &v)
void	setTimerange (const String &v)
void	setUvrange (const String &v)
void	setAntenna (const String &v)
void	setScan (const String &v)
void	setCorr (const String &v)
void	setArray (const String &v)
void	setObservation (const String &v)
void	setIntent (const String &v)
void	setFeed (const String &v)
void	setMsselect (const String &v)
void	setForceNew (const Int &forcenew)
bool	operator== (const PlotMSSelection &other) const
	Equality operators.
bool	operator!= (const PlotMSSelection &other) const
bool	fieldsEqual (const PlotMSSelection &other) const
bool	fieldsNotEqual (const PlotMSSelection &other) const
PlotMSSelection &	operator= (const PlotMSSelection &copy)
	Copy operator.
Vector< int >	getSelectedAntennas1 ()
	Return lists of antennas that have been selected.
Vector< int >	getSelectedAntennas2 ()
bool	isEmpty () const
	Returns whether or not any selections have been made.
Static Public Member Functions
static msselect String	defaultValue (Field f)
	Returns the default value for the given selection field.
Public Attributes
	fields
	fieldStrings
	field
	spw
	timerange
	uvrange
	antenna
	scan
	corr
	array
	observation
	intent
	feed
Private Member Functions
void	initDefaults ()
	Initializes the values to their defaults.
Private Attributes
std::map< Field, String >	itsValues_
	Selection field values.
Int	forceNew_
	Force appearance of new selection (even when not new).
Vector< int >	selAnts
Vector< int >	selAnts2

Detailed Description

Specifies an MS selection.

See the mssSetData method in ms/MSSel/MSSelectionTools.h for details.

Definition at line 44 of file PlotMSSelection.h.

Constructor & Destructor Documentation

casa::PlotMSSelection::PlotMSSelection ( )

Non-Static //.

Default constructor.

casa::PlotMSSelection::PlotMSSelection ( const PlotMSSelection & copy )

Copy constructor.

See operator=().

casa::PlotMSSelection::~PlotMSSelection ( )

Destructor.

Member Function Documentation

const String& casa::PlotMSSelection::antenna ( void ) const [inline]

Definition at line 112 of file PlotMSSelection.h.

References getValue().

void casa::PlotMSSelection::apply	(	NewCalTable &	ct,
		NewCalTable &	selectedCT,
		Vector< Vector< Slice > > &	chansel,
		Vector< Vector< Slice > > &	corrsel
	)

Applies this selection to a NewCaltable.

void casa::PlotMSSelection::apply	(	MeasurementSet &	ms,
		MeasurementSet &	selectedMS,
		Vector< Vector< Slice > > &	chansel,
		Vector< Vector< Slice > > &	corrsel
	)

Applies this selection using the first MS into the second MS.

(See the mssSetData method in ms/MSSel/MSSelectionTools.h for details.)

const String& casa::PlotMSSelection::array ( ) const [inline]

Definition at line 115 of file PlotMSSelection.h.

References getValue().

const String& casa::PlotMSSelection::corr ( ) const [inline]

Definition at line 114 of file PlotMSSelection.h.

References getValue().

static msselect String casa::PlotMSSelection::defaultValue ( Field f ) [static]

Returns the default value for the given selection field.

Returns an empty String except for FIELD which returns "2".

Type Constraints

const String& casa::PlotMSSelection::feed ( void ) const [inline]

Definition at line 118 of file PlotMSSelection.h.

References getValue().

const String& casa::PlotMSSelection::field ( void ) const [inline]

Convenience methods for returning the standard selection fields.

Definition at line 108 of file PlotMSSelection.h.

References getValue().

bool casa::PlotMSSelection::fieldsEqual ( const PlotMSSelection & other ) const

Referenced by fieldsNotEqual().

bool casa::PlotMSSelection::fieldsNotEqual ( const PlotMSSelection & other ) const [inline]

Definition at line 147 of file PlotMSSelection.h.

References fieldsEqual().

const Int& casa::PlotMSSelection::forceNew ( ) const [inline]

Definition at line 120 of file PlotMSSelection.h.

References forceNew_.

void casa::PlotMSSelection::fromRecord ( const RecordInterface & record )

Converts this object to/from a record.

The record keys are the values of the Field enum in String form, and the values are the String values.

Vector<int> casa::PlotMSSelection::getSelectedAntennas1 ( )

Return lists of antennas that have been selected.

Vector<int> casa::PlotMSSelection::getSelectedAntennas2 ( )

void casa::PlotMSSelection::getValue	(	Field	f,
		String &	value
	)			const `[inline]`

Definition at line 102 of file PlotMSSelection.h.

References getValue().

Referenced by getValue().

const String& casa::PlotMSSelection::getValue ( Field f ) const

Gets/Sets the value for the given selection field.

Referenced by antenna(), array(), corr(), feed(), field(), intent(), msselect(), observation(), scan(), spw(), timerange(), and uvrange().

void casa::PlotMSSelection::initDefaults ( ) [private]

Initializes the values to their defaults.

const String& casa::PlotMSSelection::intent ( ) const [inline]

Definition at line 117 of file PlotMSSelection.h.

References getValue().

bool casa::PlotMSSelection::isEmpty ( ) const

Returns whether or not any selections have been made.

const String& casa::PlotMSSelection::msselect ( ) const [inline]

Definition at line 119 of file PlotMSSelection.h.

References getValue().

const String& casa::PlotMSSelection::observation ( ) const [inline]

Definition at line 116 of file PlotMSSelection.h.

References getValue().

bool casa::PlotMSSelection::operator!= ( const PlotMSSelection & other ) const [inline]

Definition at line 143 of file PlotMSSelection.h.

References operator==().

PlotMSSelection& casa::PlotMSSelection::operator= ( const PlotMSSelection & copy )

Copy operator.

bool casa::PlotMSSelection::operator== ( const PlotMSSelection & other ) const

Equality operators.

Referenced by operator!=().

casa::PlotMSSelection::PMS_ENUM1	(	Field	,
		fields	,
		fieldStrings	,
		field	,
		FIELD	,
		SPW	,
		TIMERANGE	,
		UVRANGE	,
		ANTENNA	,
		SCAN	,
		CORR	,
		ARRAY	,
		OBSERVATION	,
		INTENT	,
		FEED	,
		MSSELECT
	)

Static //.

Enum and methods to define the different fields for an MS selection. If these are changed, also update: convenience methods below, xmlcasa/implement/plotms/plotms*, xmlcasa/tasks/plotms.xml, xmlcasa/scripts/task_plotms.py.**

const String& casa::PlotMSSelection::scan ( ) const [inline]

Definition at line 113 of file PlotMSSelection.h.

References getValue().

void casa::PlotMSSelection::setAntenna ( const String & v ) [inline]

Definition at line 129 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setArray ( const String & v ) [inline]

Definition at line 132 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setCorr ( const String & v ) [inline]

Definition at line 131 of file PlotMSSelection.h.

References setValue().