casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
casa::PlotMSSelection Class Reference

Specifies an casacore::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 //. More...
 
 PlotMSSelection ()
 Non-Static //. More...
 
 PlotMSSelection (const PlotMSSelection &copy)
 Copy constructor. More...
 
 ~PlotMSSelection ()
 Destructor. More...
 
void fromRecord (const casacore::RecordInterface &record)
 Converts this object to/from a record. More...
 
casacore::Record toRecord () const
 
casacore::String toStringShort () const
 Print out an abbreviated summary of the selection. More...
 
void apply (casacore::MeasurementSet &ms, casacore::MeasurementSet &selectedMS, casacore::Vector< casacore::Vector< casacore::Slice > > &chansel, casacore::Vector< casacore::Vector< casacore::Slice > > &corrsel)
 Applies this selection using the first casacore::MS into the second MS. More...
 
void apply (NewCalTable &ct, NewCalTable &selectedCT, casacore::Vector< casacore::Vector< casacore::Slice > > &chansel, casacore::Vector< casacore::Vector< casacore::Slice > > &corrsel)
 Applies this selection to a NewCalTable. More...
 
void apply (CalTable &ct, CalTable &selectedCT, casacore::Vector< casacore::Vector< casacore::Slice > > &chansel, casacore::Vector< casacore::Vector< casacore::Slice > > &corrsel)
 Applies this selection to a Table. More...
 
const casacore::StringgetValue (Field f) const
 Gets/Sets the value for the given selection field. More...
 
void getValue (Field f, casacore::String &value) const
 
void setValue (Field f, const casacore::String &value)
 
const casacore::Stringfield () const
 Convenience methods for returning the standard selection fields. More...
 
const casacore::Stringspw () const
 
const casacore::Stringtimerange () const
 
const casacore::Stringuvrange () const
 
const casacore::Stringantenna () const
 
const casacore::Stringscan () const
 
const casacore::Stringcorr () const
 
const casacore::Stringarray () const
 
const casacore::Stringobservation () const
 
const casacore::Stringintent () const
 
const casacore::Stringfeed () const
 
const casacore::Stringmsselect () const
 
const casacore::IntforceNew () const
 
void setField (const casacore::String &v)
 Convenience methods for setting the standard selection fields. More...
 
void setSpw (const casacore::String &v)
 
void setTimerange (const casacore::String &v)
 
void setUvrange (const casacore::String &v)
 
void setAntenna (const casacore::String &v)
 
void setScan (const casacore::String &v)
 
void setCorr (const casacore::String &v)
 
void setArray (const casacore::String &v)
 
void setObservation (const casacore::String &v)
 
void setIntent (const casacore::String &v)
 
void setFeed (const casacore::String &v)
 
void setMsselect (const casacore::String &v)
 
void setForceNew (const casacore::Int &forcenew)
 
bool operator== (const PlotMSSelection &other) const
 Equality operators. More...
 
bool operator!= (const PlotMSSelection &other) const
 
bool fieldsEqual (const PlotMSSelection &other) const
 
bool fieldsNotEqual (const PlotMSSelection &other) const
 
PlotMSSelectionoperator= (const PlotMSSelection &copy)
 Copy operator. More...
 
casacore::Vector< int > getSelectedAntennas1 ()
 Return lists of antennas that have been selected. More...
 
casacore::Vector< int > getSelectedAntennas2 ()
 
bool isEmpty () const
 Returns whether or not any selections have been made. More...
 

Static Public Member Functions

static msselect casacore::String defaultValue (Field f)
 Returns the default value for the given selection field. More...
 

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. More...
 
casacore::String getTaql (CalTable &ct)
 CalTable::select uses taql string for selection. More...
 
casacore::String getAntTaql (casacore::MSSelection &mss, casacore::MeasurementSet &ms, casacore::String antExpr)
 handle negation More...
 
casacore::String getMSName (CalTable &ct)
 For MS + MSSelection. More...
 

Private Attributes

std::map< Field, casacore::StringitsValues_
 Selection field values. More...
 
casacore::Int forceNew_
 Force appearance of new selection (even when not new) More...
 
casacore::Vector< int > selAnts1
 
casacore::Vector< int > selAnts2
 

Detailed Description

Specifies an casacore::MS selection.

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

Definition at line 50 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 casacore::String& casa::PlotMSSelection::antenna ( void  ) const
inline

Definition at line 124 of file PlotMSSelection.h.

References getValue().

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

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

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

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

Applies this selection to a NewCalTable.

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

Applies this selection to a Table.

const casacore::String& casa::PlotMSSelection::array ( ) const
inline

Definition at line 127 of file PlotMSSelection.h.

References getValue().

const casacore::String& casa::PlotMSSelection::corr ( ) const
inline

Definition at line 126 of file PlotMSSelection.h.

References getValue().

static msselect casacore::String casa::PlotMSSelection::defaultValue ( Field  f)
static

Returns the default value for the given selection field.

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

const casacore::String& casa::PlotMSSelection::feed ( void  ) const
inline

Definition at line 130 of file PlotMSSelection.h.

References getValue().

const casacore::String& casa::PlotMSSelection::field ( void  ) const
inline

Convenience methods for returning the standard selection fields.

Definition at line 120 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 159 of file PlotMSSelection.h.

References fieldsEqual().

const casacore::Int& casa::PlotMSSelection::forceNew ( ) const
inline

Definition at line 132 of file PlotMSSelection.h.

References forceNew_.

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

Converts this object to/from a record.

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

casacore::String casa::PlotMSSelection::getAntTaql ( casacore::MSSelection mss,
casacore::MeasurementSet ms,
casacore::String  antExpr 
)
private

handle negation

casacore::String casa::PlotMSSelection::getMSName ( CalTable ct)
private

For MS + MSSelection.

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

Return lists of antennas that have been selected.

casacore::Vector<int> casa::PlotMSSelection::getSelectedAntennas2 ( )
casacore::String casa::PlotMSSelection::getTaql ( CalTable ct)
private

CalTable::select uses taql string for selection.

const casacore::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::getValue ( Field  f,
casacore::String value 
) const
inline

Definition at line 114 of file PlotMSSelection.h.

References getValue().

Referenced by getValue().

void casa::PlotMSSelection::initDefaults ( )
private

Initializes the values to their defaults.

const casacore::String& casa::PlotMSSelection::intent ( ) const
inline

Definition at line 129 of file PlotMSSelection.h.

References getValue().

bool casa::PlotMSSelection::isEmpty ( ) const

Returns whether or not any selections have been made.

const casacore::String& casa::PlotMSSelection::msselect ( ) const
inline

Definition at line 131 of file PlotMSSelection.h.

References getValue().

const casacore::String& casa::PlotMSSelection::observation ( ) const
inline

Definition at line 128 of file PlotMSSelection.h.

References getValue().

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

Definition at line 155 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 casacore::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 casacore::String& casa::PlotMSSelection::scan ( ) const
inline

Definition at line 125 of file PlotMSSelection.h.

References getValue().

void casa::PlotMSSelection::setAntenna ( const casacore::String v)
inline

Definition at line 141 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setArray ( const casacore::String v)
inline

Definition at line 144 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setCorr ( const casacore::String v)
inline

Definition at line 143 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setFeed ( const casacore::String v)
inline

Definition at line 147 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setField ( const casacore::String v)
inline

Convenience methods for setting the standard selection fields.

Definition at line 137 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setForceNew ( const casacore::Int forcenew)
inline

Definition at line 149 of file PlotMSSelection.h.

References forceNew_.

void casa::PlotMSSelection::setIntent ( const casacore::String v)
inline

Definition at line 146 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setMsselect ( const casacore::String v)
inline

Definition at line 148 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setObservation ( const casacore::String v)
inline

Definition at line 145 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setScan ( const casacore::String v)
inline

Definition at line 142 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setSpw ( const casacore::String v)
inline

Definition at line 138 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setTimerange ( const casacore::String v)
inline

Definition at line 139 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setUvrange ( const casacore::String v)
inline

Definition at line 140 of file PlotMSSelection.h.

References setValue().

void casa::PlotMSSelection::setValue ( Field  f,
const casacore::String value 
)
const casacore::String& casa::PlotMSSelection::spw ( void  ) const
inline

Definition at line 121 of file PlotMSSelection.h.

References getValue().

const casacore::String& casa::PlotMSSelection::timerange ( ) const
inline

Definition at line 122 of file PlotMSSelection.h.

References getValue().

casacore::Record casa::PlotMSSelection::toRecord ( ) const
casacore::String casa::PlotMSSelection::toStringShort ( ) const

Print out an abbreviated summary of the selection.

const casacore::String& casa::PlotMSSelection::uvrange ( ) const
inline

Definition at line 123 of file PlotMSSelection.h.

References getValue().

Member Data Documentation

casa::PlotMSSelection::antenna

Definition at line 62 of file PlotMSSelection.h.

casa::PlotMSSelection::array

Definition at line 62 of file PlotMSSelection.h.

casa::PlotMSSelection::corr

Definition at line 62 of file PlotMSSelection.h.

casa::PlotMSSelection::feed

Definition at line 62 of file PlotMSSelection.h.

casa::PlotMSSelection::field

Definition at line 62 of file PlotMSSelection.h.

casa::PlotMSSelection::fields

Definition at line 62 of file PlotMSSelection.h.

casa::PlotMSSelection::fieldStrings

Definition at line 62 of file PlotMSSelection.h.

casacore::Int casa::PlotMSSelection::forceNew_
private

Force appearance of new selection (even when not new)

Definition at line 179 of file PlotMSSelection.h.

Referenced by forceNew(), and setForceNew().

casa::PlotMSSelection::intent

Definition at line 62 of file PlotMSSelection.h.

std::map<Field, casacore::String> casa::PlotMSSelection::itsValues_
private

Selection field values.

Definition at line 176 of file PlotMSSelection.h.

casa::PlotMSSelection::observation

Definition at line 62 of file PlotMSSelection.h.

casa::PlotMSSelection::scan

Definition at line 62 of file PlotMSSelection.h.

casacore::Vector<int> casa::PlotMSSelection::selAnts1
private

Definition at line 180 of file PlotMSSelection.h.

casacore::Vector<int> casa::PlotMSSelection::selAnts2
private

Definition at line 181 of file PlotMSSelection.h.

casa::PlotMSSelection::spw

Definition at line 62 of file PlotMSSelection.h.

casa::PlotMSSelection::timerange

Definition at line 62 of file PlotMSSelection.h.

casa::PlotMSSelection::uvrange

Definition at line 62 of file PlotMSSelection.h.


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