casa::CTSelection Class Reference

CTSelection: Class to represent a selection on a CASA CalTable. More...

#include <CTSelection.h>

List of all members.

Public Member Functions

 CTSelection ()
 Default null constructor, and destructor.
virtual ~CTSelection ()
TableExprNode toTableExprNode (MSSelectableTable *msLike)
 CTSelection (const NewCalTable &ct, const MSSMode &mode=PARSE_NOW, const String &timeExpr="", const String &antennaExpr="", const String &fieldExpr="", const String &spwExpr="", const String &uvDistExpr="", const String &taqlExpr="", const String &polnExpr="", const String &scanExpr="", const String &arrayExpr="", const String &stateExpr="", const String &observationExpr="")
 Construct using an MS and the various selection expressions to be applied to the given MS.
 CTSelection (const Record &selectionItem)
 Construct from a record representing a selection item at the CLI or user interface level.
 CTSelection (const CTSelection &other)
 Copy constructor.
CTSelection & operator= (const CTSelection &other)
 Assignment operator.
void reset (MSSelectableTable &msLike, const MSSMode &mode=PARSE_NOW, const String &timeExpr="", const String &antennaExpr="", const String &fieldExpr="", const String &spwExpr="", const String &uvDistExpr="", const String &taqlExpr="", const String &polnExpr="", const String &scanExpr="", const String &arrayExpr="", const String &stateExpr="", const String &observationExpr="")
 Accessor for result of parsing all of the selection expressions.

Detailed Description

CTSelection: Class to represent a selection on a CASA CalTable.

Intended use:

Public interface

Prerequisite

Etymology

From "CalTable" and "selection".

Synopsis

The CTSelection class represents a selection on a CASA CalTable (CT).

The purpose of this class is to provides a simple expression based selection mechanism to both the end-user and developer wishing to perform query operations over a measurement set. This class is a specialization of the CASACORE MSSelection class. The specialization this provides is that this workes with CT and uses parsers specialization for CT where necessary. For a complete list of the STaQL interface refer to the MeasurementSet Selection Syntax document at: Data Selection

The sub-expressions are interpreted in the order which they were set. The order however in not important - any dependency on the order in which the expressions are evaluated is handled internally. The result of parsing the expressions is TableExprNode (TEN). All TENs from sub-expressions are finally ANDed and the resultant TEN is used to select the rows of the MS table.

Example

Motivation



Definition at line 100 of file CTSelection.h.


Constructor & Destructor Documentation






      

        

          casa::CTSelection::CTSelection 
          (
          
           ) 
          
        

      







Default null constructor, and destructor. 











      

        

          virtual casa::CTSelection::~CTSelection 
          (
          
           ) 
           [virtual]
        

      















      

        

          casa::CTSelection::CTSelection 
          (
          const NewCalTable & 
           ct, 
        

        

          
          
          const MSSMode & 
           mode = PARSE_NOW, 
        

        

          
          
          const String & 
           timeExpr = "", 
        

        

          
          
          const String & 
           antennaExpr = "", 
        

        

          
          
          const String & 
           fieldExpr = "", 
        

        

          
          
          const String & 
           spwExpr = "", 
        

        

          
          
          const String & 
           uvDistExpr = "", 
        

        

          
          
          const String & 
           taqlExpr = "", 
        

        

          
          
          const String & 
           polnExpr = "", 
        

        

          
          
          const String & 
           scanExpr = "", 
        

        

          
          
          const String & 
           arrayExpr = "", 
        

        

          
          
          const String & 
           stateExpr = "", 
        

        

          
          
          const String & 
           observationExpr = "" 
        

        

          
          )
          
        

      







Construct using an MS and the various selection expressions to be applied to the given MS. 


By default, the expressions will be parsed immediately. With mode=PARSE_LATE, the parsing will be done with a call to toTableExprNode(). 











      

        

          casa::CTSelection::CTSelection 
          (
          const Record & 
           selectionItem
           ) 
          
        

      







Construct from a record representing a selection item at the CLI or user interface level. 


This is functionally same as the constructor above with mode=PARSE_LATE. 











      

        

          casa::CTSelection::CTSelection 
          (
          const CTSelection & 
           other
           ) 
          
        

      







Copy constructor. 







Member Function Documentation






      

        

          CTSelection& casa::CTSelection::operator= 
          (
          const CTSelection & 
           other
           ) 
          
        

      







Assignment operator. 











      

        

          void casa::CTSelection::reset 
          (
          MSSelectableTable & 
           msLike, 
        

        

          
          
          const MSSMode & 
           mode = PARSE_NOW, 
        

        

          
          
          const String & 
           timeExpr = "", 
        

        

          
          
          const String & 
           antennaExpr = "", 
        

        

          
          
          const String & 
           fieldExpr = "", 
        

        

          
          
          const String & 
           spwExpr = "", 
        

        

          
          
          const String & 
           uvDistExpr = "", 
        

        

          
          
          const String & 
           taqlExpr = "", 
        

        

          
          
          const String & 
           polnExpr = "", 
        

        

          
          
          const String & 
           scanExpr = "", 
        

        

          
          
          const String & 
           arrayExpr = "", 
        

        

          
          
          const String & 
           stateExpr = "", 
        

        

          
          
          const String & 
           observationExpr = "" 
        

        

          
          )
          
        

      







Accessor for result of parsing all of the selection expressions. 


The final TableExprNode (TEN) is the result of ANDing the TENs for the individual expressions. TableExprNode getTEN(const MeasurementSet*ms = NULL);


Accessor for the list of antenna-1 of the selected baselines. Antennas affected by the baseline negation operator have the antenna IDs multiplied by -1.


inline Vector<Int> getAntenna1List(const MeasurementSet* ms=NULL) {getTEN(ms); return antenna1IDs_p;}


Accessor for the list of antenna-2 of the selected baselines. Antennas affected by the baseline negation operator have the antenna IDs multiplied by -1. inline Vector<Int> getAntenna2List(const MeasurementSet* ms=NULL) {getTEN(ms); return antenna2IDs_p;}


inline Matrix<Int> getBaselineList(const MeasurementSet* ms=NULL) {getTEN(ms); return baselineIDs_p;}


// Accessor for the list of selected field IDs. inline Vector<Int> getFieldList(const MeasurementSet* ms=NULL) {// if (fieldIDs_p.nelements() <= 0) getTEN(ms); return fieldIDs_p;}


// Accessor for the list of the specified time range(s) as the // start and end MJD values. The time ranges are stored as columns, // i.e. the output Matrix is 2 x n_ranges. inline Matrix<Double> getTimeList(const MeasurementSet* ms=NULL) {getTEN(ms); return selectedTimesList_p;}


// Accessor for the list of the selected Spectral Window IDs. inline Vector<Int> getSpwList(const MeasurementSet* ms=NULL) {// if (spwIDs_p.nelements() <= 0) getTEN(ms); return spwIDs_p;}


Matrix<Int> getChanList(const MeasurementSet* ms=NULL, const Int defaultStep=1, const Bool sorted=False);


// // Same as getChanList, except that the channels and steps are in Hz. // Matrix<Double> getChanFreqList(const MeasurementSet* ms=NULL, const Bool sorted=False);


// Accessor for the list of the selected Data Description IDs from // the SPW expression parsing. The actual // selected DDIDs would be an intersection of the DDIDs selected // from polarization and SPW expressions parsing (see // getDDIDList() above). inline Vector<Int> getSPWDDIDList(const MeasurementSet* ms=NULL) {if (spwDDIDs_p.nelements() <= 0) getTEN(ms); return spwDDIDs_p;}


// // The key in the ordered map returned by getPolMap() is the Data // Description ID (DDID). The value is a vector containing the // list of in-row indices to pick out the selected polarizations // (or equivalently, the list of indices for the vector in the // corrType column of the POLARIZATION sub-table). These are also // what the user intended (i.e., e.g. not all DD IDs due to user // POL expression might be selected due to SPW expressions). // inline OrderedMap<Int, Vector<Int> > getPolMap(const MeasurementSet* ms=NULL) {getTEN(ms); return selectedPolMap_p;};


// // The key in the ordered map returned by getCorrMap() is the // pol. is the Data Description ID (DDID). The value is a set of // two vectors. The first vector is the list of the in-row // indices to pick out the selected polarizations (or // equivalently, the list of indices for the vector in the // corrType column of the POLARIZATION sub-table). // inline OrderedMap<Int, Vector<Vector<Int> > > getCorrMap(const MeasurementSet* ms=NULL) {getTEN(ms); return selectedSetupMap_p;};


// Methods to convert the maps return by getChanList and // getCorrMap to a list of Slice which can be directly used by // Table system for in-row selection of frequency channels and // polarizations. void getChanSlices(Vector<Vector<Slice> >& chanslices, const MeasurementSet* ms=NULL, const Int defaultChanStep=1);


void getCorrSlices(Vector<Vector<Slice> >& corrslices, const MeasurementSet* ms=NULL);


This version of reset() works with generic MSSeletableTable object. Accessing the services of the CTSelection module via this interface is recommended over the version of reset() that uses MeasurementSet. 











      

        

          TableExprNode casa::CTSelection::toTableExprNode 
          (
          MSSelectableTable * 
           msLike
           ) 
          
        

      











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





 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines










Generated on 31 Aug 2016 for casa by 

doxygen 1.6.1