casacore
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::FrequencyUDF Class Reference

More...

#include <FrequencyUDF.h>

Public Types

enum  FuncType {
  FREQUENCY ,
  REST ,
  SHIFT
}
 Define the possible function types. More...
 
- Public Types inherited from casacore::UDFBase
typedef UDFBaseMakeUDFObject(const String &functionName)
 The signature of a global or static member function creating an object of the UDF. More...
 

Public Member Functions

 FrequencyUDF (FuncType)
 Create for the given function type. More...
 
virtual void setup (const Table &, const TaQLStyle &)
 Setup the object. More...
 
virtual Double getDouble (const TableExprId &id)
 Get the value. More...
 
virtual MArray< DoublegetArrayDouble (const TableExprId &id)
 
- Public Member Functions inherited from casacore::UDFBase
 UDFBase ()
 Only default constructor is needed. More...
 
virtual ~UDFBase ()
 Destructor. More...
 
virtual Bool getBool (const TableExprId &id)
 Evaluate the function and return the result. More...
 
virtual Int64 getInt (const TableExprId &id)
 
virtual DComplex getDComplex (const TableExprId &id)
 
virtual String getString (const TableExprId &id)
 
virtual TaqlRegex getRegex (const TableExprId &id)
 
virtual MVTime getDate (const TableExprId &id)
 
virtual MArray< BoolgetArrayBool (const TableExprId &id)
 
virtual MArray< Int64getArrayInt (const TableExprId &id)
 
virtual MArray< DComplex > getArrayDComplex (const TableExprId &id)
 
virtual MArray< StringgetArrayString (const TableExprId &id)
 
virtual MArray< MVTimegetArrayDate (const TableExprId &id)
 
const StringgetUnit () const
 Get the unit. More...
 
const RecordgetAttributes () const
 Get the attributes. More...
 
void getAggrNodes (vector< TableExprNodeRep * > &aggr)
 Get the nodes in the function operands representing an aggregate function. More...
 
void getColumnNodes (vector< TableExprNodeRep * > &cols)
 Get the nodes in the function operands representing a table column. More...
 
void init (const std::vector< TENShPtr > &arg, const Table &table, const TaQLStyle &)
 Initialize the function object. More...
 
TableExprNodeRep::NodeDataType dataType () const
 Get the data type. More...
 
Int ndim () const
 Get the dimensionality of the results. More...
 
const IPositionshape () const
 Get the result shape if the same for all results. More...
 
Bool isConstant () const
 Tell if the UDF gives a constant result. More...
 
Bool isAggregate () const
 Tell if the UDF is an aggregate function. More...
 
void disableApplySelection ()
 Do not apply the selection. More...
 
void applySelection (const Vector< rownr_t > &rownrs)
 If needed, let the UDF re-create column objects for a selection of rows. More...
 

Static Public Member Functions

static UDFBasemakeFREQ (const String &)
 Function to create an object. More...
 
static UDFBasemakeREST (const String &)
 
static UDFBasemakeSHIFT (const String &)
 
- Static Public Member Functions inherited from casacore::UDFBase
static void registerUDF (const String &name, MakeUDFObject *func)
 Register the name and construction function of a UDF (thread-safe). More...
 
static UDFBasecreateUDF (const String &name, const TaQLStyle &style)
 Create a UDF object (thread-safe). More...
 

Private Member Functions

Bool handleRadVelDoppler (uInt &argnr, Bool mustRadVel)
 Handle a radial velocity or optionally doppler for REST conversion. More...
 

Private Attributes

FrequencyEngine itsEngine
 
DopplerEngine itsDopplerEngine
 
RadialVelocityEngine itsRadVelEngine
 
DirectionEngine itsDirectionEngine
 
EpochEngine itsEpochEngine
 
PositionEngine itsPositionEngine
 
FuncType itsType
 
MFrequency::Types itsRefType
 

Additional Inherited Members

- Protected Member Functions inherited from casacore::UDFBase
std::vector< TENShPtr > & operands ()
 Get the operands. More...
 
void setDataType (TableExprNodeRep::NodeDataType)
 Set the data type. More...
 
void setNDim (Int ndim)
 Set the dimensionality of the results. More...
 
void setShape (const IPosition &shape)
 Set the shape of the results if it is fixed and known. More...
 
void setUnit (const String &unit)
 Set the unit of the result. More...
 
void setAttributes (const Record &attributes)
 Set the attributes of the result. More...
 
void setConstant (Bool isConstant)
 Define if the result is constant (e.g. More...
 
void setAggregate (Bool isAggregate)
 Define if the UDF is an aggregate function (usually used in GROUPBY). More...
 
virtual void recreateColumnObjects (const Vector< rownr_t > &rownrs)
 Let a derived class recreate its column objects in case a selection has to be applied. More...
 

Detailed Description

TaQL UDFs for Frequency conversions.

Intended use:

Public interface

Review Status

Test programs:
tMeas

Prerequisite

Synopsis

FrequencyUDF defines UDFs (user defined functions) that can be used in TaQL to convert Measures for frequencys. Special functions exist to convert to hourangle and azimuth/elevation. In this way such derived values appear to be ordinary TaQL functions.

A function is called like:

meas.dir (toref, dir, time, pos)
meas.dir (toref, dir, time, pos)
For example,
meas.dir ('B1950', [2rad,1rad])
meas.dir ('B1950', [[2rad,1rad], 'J2000'])
meas.dir ('APP', 'MOON', TIME, [[5d12m, 52deg, 11m], 'WGS84'])
meas.dir ('APP', 'MOON', TIME, POSITION)
Or
meas.dir (toref, fromref, dir, pos, time)
TableExprNode time(const TableExprNode &node)
Definition: ExprNode.h:1580

All functions have data type double and unit radian.

Motivation

It makes it possible to handle measures in TaQL.

Definition at line 92 of file FrequencyUDF.h.

Member Enumeration Documentation

◆ FuncType

Define the possible function types.

Enumerator
FREQUENCY 
REST 
SHIFT 

Definition at line 96 of file FrequencyUDF.h.

Constructor & Destructor Documentation

◆ FrequencyUDF()

casacore::FrequencyUDF::FrequencyUDF ( FuncType  )
explicit

Create for the given function type.

Member Function Documentation

◆ getArrayDouble()

virtual MArray<Double> casacore::FrequencyUDF::getArrayDouble ( const TableExprId id)
virtual

Reimplemented from casacore::UDFBase.

◆ getDouble()

virtual Double casacore::FrequencyUDF::getDouble ( const TableExprId id)
virtual

Get the value.

Reimplemented from casacore::UDFBase.

◆ handleRadVelDoppler()

Bool casacore::FrequencyUDF::handleRadVelDoppler ( uInt argnr,
Bool  mustRadVel 
)
private

Handle a radial velocity or optionally doppler for REST conversion.

It returns True if Doppler is used.

◆ makeFREQ()

static UDFBase* casacore::FrequencyUDF::makeFREQ ( const String )
static

Function to create an object.

◆ makeREST()

static UDFBase* casacore::FrequencyUDF::makeREST ( const String )
static

◆ makeSHIFT()

static UDFBase* casacore::FrequencyUDF::makeSHIFT ( const String )
static

◆ setup()

virtual void casacore::FrequencyUDF::setup ( const Table ,
const TaQLStyle  
)
virtual

Setup the object.

Implements casacore::UDFBase.

Member Data Documentation

◆ itsDirectionEngine

DirectionEngine casacore::FrequencyUDF::itsDirectionEngine
private

Definition at line 122 of file FrequencyUDF.h.

◆ itsDopplerEngine

DopplerEngine casacore::FrequencyUDF::itsDopplerEngine
private

Definition at line 120 of file FrequencyUDF.h.

◆ itsEngine

FrequencyEngine casacore::FrequencyUDF::itsEngine
private

Definition at line 119 of file FrequencyUDF.h.

◆ itsEpochEngine

EpochEngine casacore::FrequencyUDF::itsEpochEngine
private

Definition at line 123 of file FrequencyUDF.h.

◆ itsPositionEngine

PositionEngine casacore::FrequencyUDF::itsPositionEngine
private

Definition at line 124 of file FrequencyUDF.h.

◆ itsRadVelEngine

RadialVelocityEngine casacore::FrequencyUDF::itsRadVelEngine
private

Definition at line 121 of file FrequencyUDF.h.

◆ itsRefType

MFrequency::Types casacore::FrequencyUDF::itsRefType
private

Definition at line 126 of file FrequencyUDF.h.

◆ itsType

FuncType casacore::FrequencyUDF::itsType
private

Definition at line 125 of file FrequencyUDF.h.


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