casacore
Public Member Functions | Private Attributes | List of all members
casacore::MSInterface Class Reference
ms package (libcasa_ms) » MSSel_module


MSInterface: A specialization of MSSelectableTable for accessing MS. More...

#include <MSSelectableTable.h>

Public Member Functions

 MSInterface ()
 
 MSInterface (const Table &table)
 
virtual ~MSInterface ()
 
virtual const MSAntenna & antenna ()
 
virtual const MSField & field ()
 
virtual const MSSpectralWindow & spectralWindow ()
 
virtual const MSDataDescription & dataDescription ()
 
virtual const MSObservation & observation ()
 
virtual String columnName (MSMainEnums::PredefinedColumns nameEnum)
 
virtual Bool isMS ()
 
virtual MSSDataType dataType ()
 
virtual const MeasurementSet * asMS ()
 
virtual MSSelectableMainColumn * mainColumns ()
 
- Public Member Functions inherited from casacore::MSSelectableTable
 MSSelectableTable ()
 
 MSSelectableTable (const Table &table)
 
virtual ~MSSelectableTable ()
 
virtual void setTable (const Table &table)
 
const Table * table ()
 
TableExprNode col (const String &colName)
 

Private Attributes

MSMainColInterface * msMainCols_p
 

Additional Inherited Members

- Public Types inherited from casacore::MSSelectableTable
enum  MSSDataType {
  BASELINE_BASED ,
  PURE_ANTENNA_BASED ,
  REF_ANTENNA_BASED
}
 
- Protected Attributes inherited from casacore::MSSelectableTable
const Table * table_p
 

Detailed Description


MSInterface: A specialization of MSSelectableTable for accessing MS.

Intended use:

Public interface

Etymology

From "ms" and "interface".

Synopsis

A class that can be passed around as MSSelectableTable, with most of the methods overloaded to work with the underlaying MS.

Example

//
// Fill in the expression in the various strings that are passed for
// parsing to the MSSelection object later.
//
String fieldStr,timeStr,spwStr,baselineStr,
uvdistStr,taqlStr,scanStr,arrayStr, polnStr,stateObsModeStr,
observationStr;
baselineStr="1&2";
timeStr="*+0:10:0";
fieldStr="CygA*";
//
// Instantiate the MS and the MSInterface objects.
//
MS ms(MSName),selectedMS(ms);
MSInterface msInterface(ms);
//
// Setup the MSSelection thingi
//
MSSelection msSelection;
msSelection.reset(msInterface,MSSelection::PARSE_NOW,
timeStr,baselineStr,fieldStr,spwStr,
uvdistStr,taqlStr,polnStr,scanStr,arrayStr,
stateObsModeStr,observationStr);
if (msSelection.getSelectedMS(selectedMS))
cerr << "Got the selected MS!" << endl;
else
cerr << "The set of expressions resulted into null-selection";
casacore::MS
MeasurementSet MS
MeasurementSet is too cumbersome for a number of common uses, so we give a typedef here.
Definition: MeasurementSet.h:110

Motivation

To generalize the implementation of the MSSelection parsers.

Definition at line 196 of file MSSelectableTable.h.

Constructor & Destructor Documentation

◆ MSInterface() [1/2]

casacore::MSInterface::MSInterface ( )
inline

Definition at line 199 of file MSSelectableTable.h.

◆ MSInterface() [2/2]

casacore::MSInterface::MSInterface ( const Table &  table)

◆ ~MSInterface()

virtual casacore::MSInterface::~MSInterface ( )
inlinevirtual

Definition at line 201 of file MSSelectableTable.h.

References msMainCols_p.

Member Function Documentation

◆ antenna()

virtual const MSAntenna& casacore::MSInterface::antenna ( )
inlinevirtual

Implements casacore::MSSelectableTable.

Definition at line 202 of file MSSelectableTable.h.

References casacore::MeasurementSet::antenna(), and asMS().

◆ asMS()

virtual const MeasurementSet* casacore::MSInterface::asMS ( )
inlinevirtual

Implements casacore::MSSelectableTable.

Definition at line 211 of file MSSelectableTable.h.

References casacore::MSSelectableTable::table().

Referenced by antenna(), dataDescription(), field(), observation(), and spectralWindow().

◆ columnName()

virtual String casacore::MSInterface::columnName ( MSMainEnums::PredefinedColumns  nameEnum)
inlinevirtual

Implements casacore::MSSelectableTable.

Definition at line 207 of file MSSelectableTable.h.

References casacore::MSTable< MSMainEnums >::columnName().

◆ dataDescription()

virtual const MSDataDescription& casacore::MSInterface::dataDescription ( )
inlinevirtual

Implements casacore::MSSelectableTable.

Definition at line 205 of file MSSelectableTable.h.

References asMS(), and casacore::MeasurementSet::dataDescription().

◆ dataType()

virtual MSSDataType casacore::MSInterface::dataType ( )
inlinevirtual

Implements casacore::MSSelectableTable.

Definition at line 209 of file MSSelectableTable.h.

References casacore::MSSelectableTable::BASELINE_BASED.

◆ field()

virtual const MSField& casacore::MSInterface::field ( )
inlinevirtual

Implements casacore::MSSelectableTable.

Definition at line 203 of file MSSelectableTable.h.

References asMS(), and casacore::MeasurementSet::field().

◆ isMS()

virtual Bool casacore::MSInterface::isMS ( )
inlinevirtual

Implements casacore::MSSelectableTable.

Definition at line 208 of file MSSelectableTable.h.

References casacore::True.

◆ mainColumns()

virtual MSSelectableMainColumn* casacore::MSInterface::mainColumns ( )
inlinevirtual

Implements casacore::MSSelectableTable.

Definition at line 212 of file MSSelectableTable.h.

References msMainCols_p, and casacore::MSSelectableTable::table_p.

◆ observation()

virtual const MSObservation& casacore::MSInterface::observation ( )
inlinevirtual

Implements casacore::MSSelectableTable.

Definition at line 206 of file MSSelectableTable.h.

References asMS(), and casacore::MeasurementSet::observation().

◆ spectralWindow()

virtual const MSSpectralWindow& casacore::MSInterface::spectralWindow ( )
inlinevirtual

Implements casacore::MSSelectableTable.

Definition at line 204 of file MSSelectableTable.h.

References asMS(), and casacore::MeasurementSet::spectralWindow().

Member Data Documentation

◆ msMainCols_p

MSMainColInterface* casacore::MSInterface::msMainCols_p
private

Definition at line 215 of file MSSelectableTable.h.

Referenced by mainColumns(), and ~MSInterface().

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1