casacore
Loading...
Searching...
No Matches
casacore::MSFeedIndex Class Reference

More...

#include <MSFeedIndex.h>

Public Member Functions

 MSFeedIndex ()
 no index attached, use the attach function or assignment operator to change that
 MSFeedIndex (const MSFeed &feed)
 construct one using the indicated FEED table
 MSFeedIndex (const MSFeedIndex &other)
 construct one from another
virtual ~MSFeedIndex ()
MSFeedIndex & operator= (const MSFeedIndex &other)
void attach (const MSFeed &feed)
Int & antennaId ()
 access to the antenna ID key, throws an exception if isNull() is False
Int & feedId ()
 access to the feed ID key, throws an exception if isNull() is False
Int & spectralWindowId ()
 access to the spectral window ID key, throws an exception if isNull() is False
Vector< Int > matchFeedPolznAndAngle (const Int &antennaId, const Vector< String > &polznType, const Vector< Float > &receptorAngle, const Float &tol, Vector< Int > &rowNumbers)
 return feed id.
Vector< Int > matchAntennaId (const Int &antennaId, Vector< Int > &rowNumbers)
 return feed id.
Vector< Int > matchFeedId (const Vector< Int > &sourceId)
 return valid feed id.
Public Member Functions inherited from casacore::MSTableIndex
 MSTableIndex ()
 no index attached, use the attach function or assignment operator to change that
 MSTableIndex (const Table &subTable, const Vector< String > &indexCols, ColumnsIndex::Compare *compareFunction=0)
 construct one using the indicated subtable which is part of the parent MS using the indicated index columns.
 MSTableIndex (const MSTableIndex &other)
 construct one from another
virtual ~MSTableIndex ()
MSTableIndex & operator= (const MSTableIndex &other)
 assignment operator, refernce semantics
void attach (const Table &subTable, const Vector< String > &indexCols, ColumnsIndex::Compare *compareFunction=0)
 attach this to a subtable using indexCols
virtual void setChanged ()
 Call this when an index in an existing row has changed.
virtual Record & accessKey ()
 access the record of index (integer) keys
virtual Double & time ()
 access the TIME to use in the search (seconds)
virtual Double & interval ()
 access the INTERVAL to use in the search (seconds), must be >= 0
virtual RowNumbers getRowNumbers ()
 get all of the rows in the subTable which have data during the indicated time and interval values.
virtual Int64 getNearestRow (Bool &found)
 get the row number which falls in the interval and has the time nearest to the center of the interval (time()).
virtual Bool isNull ()
 is this attached to a null table
virtual Table & table ()
 return the subtable being indexed

Static Protected Member Functions

static Int compare (const Block< void * > &fieldPtrs, const Block< void * > &dataPtrs, const Block< Int > &dataTypes, rownr_t index)
 the specialized compare function to pass to the ColumnsIndex object.

Private Member Functions

void attachIds ()

Private Attributes

RecordFieldPtr< Int > antennaId_p
RecordFieldPtr< Int > feedId_p
RecordFieldPtr< Int > spwId_p
MSFeedColumns * msFeedCols_p
 Pointer to FEED columns accessor.

Detailed Description

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

Example

Motivation

Thrown Exceptions

Definition at line 71 of file MSFeedIndex.h.

Constructor & Destructor Documentation

◆ MSFeedIndex() [1/3]

casacore::MSFeedIndex::MSFeedIndex ( )

no index attached, use the attach function or assignment operator to change that

Referenced by MSFeedIndex(), and operator=().

◆ MSFeedIndex() [2/3]

casacore::MSFeedIndex::MSFeedIndex ( const MSFeed & feed)

construct one using the indicated FEED table

◆ MSFeedIndex() [3/3]

casacore::MSFeedIndex::MSFeedIndex ( const MSFeedIndex & other)

construct one from another

References MSFeedIndex().

◆ ~MSFeedIndex()

virtual casacore::MSFeedIndex::~MSFeedIndex ( )
virtual

Member Function Documentation

◆ antennaId()

Int & casacore::MSFeedIndex::antennaId ( )
inline

access to the antenna ID key, throws an exception if isNull() is False

Definition at line 90 of file MSFeedIndex.h.

References antennaId_p.

Referenced by matchAntennaId(), and matchFeedPolznAndAngle().

◆ attach()

void casacore::MSFeedIndex::attach ( const MSFeed & feed)

◆ attachIds()

void casacore::MSFeedIndex::attachIds ( )
private

◆ compare()

Int casacore::MSFeedIndex::compare ( const Block< void * > & fieldPtrs,
const Block< void * > & dataPtrs,
const Block< Int > & dataTypes,
rownr_t index )
staticprotected

the specialized compare function to pass to the ColumnsIndex object.

This supports -1 values for the SPECTRAL_WINDOW_ID

◆ feedId()

Int & casacore::MSFeedIndex::feedId ( )
inline

access to the feed ID key, throws an exception if isNull() is False

Definition at line 93 of file MSFeedIndex.h.

References feedId_p.

◆ matchAntennaId()

Vector< Int > casacore::MSFeedIndex::matchAntennaId ( const Int & antennaId,
Vector< Int > & rowNumbers )

return feed id.

's (and associated row numbers) for a given antenna id.

References antennaId().

◆ matchFeedId()

Vector< Int > casacore::MSFeedIndex::matchFeedId ( const Vector< Int > & sourceId)

return valid feed id.

's for a given list of feed id.'s.

◆ matchFeedPolznAndAngle()

Vector< Int > casacore::MSFeedIndex::matchFeedPolznAndAngle ( const Int & antennaId,
const Vector< String > & polznType,
const Vector< Float > & receptorAngle,
const Float & tol,
Vector< Int > & rowNumbers )

return feed id.

's (and associated row numbers) for a given antenna id., polzn type and receptor angle

References antennaId().

◆ operator=()

MSFeedIndex & casacore::MSFeedIndex::operator= ( const MSFeedIndex & other)

References MSFeedIndex().

◆ spectralWindowId()

Int & casacore::MSFeedIndex::spectralWindowId ( )
inline

access to the spectral window ID key, throws an exception if isNull() is False

Definition at line 96 of file MSFeedIndex.h.

References spwId_p.

Member Data Documentation

◆ antennaId_p

RecordFieldPtr<Int> casacore::MSFeedIndex::antennaId_p
private

Definition at line 122 of file MSFeedIndex.h.

Referenced by antennaId().

◆ feedId_p

RecordFieldPtr<Int> casacore::MSFeedIndex::feedId_p
private

Definition at line 122 of file MSFeedIndex.h.

Referenced by feedId().

◆ msFeedCols_p

MSFeedColumns* casacore::MSFeedIndex::msFeedCols_p
private

Pointer to FEED columns accessor.

Definition at line 125 of file MSFeedIndex.h.

◆ spwId_p

RecordFieldPtr<Int> casacore::MSFeedIndex::spwId_p
private

Definition at line 122 of file MSFeedIndex.h.

Referenced by spectralWindowId().


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