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

More...

#include <EarthMagneticUDF.h>

Public Types

enum  FuncType {
  EMXYZ ,
  EMANG ,
  EMLEN ,
  IGRFXYZ ,
  IGRFANG ,
  IGRFLEN ,
  IGRFLOS ,
  IGRFLONG
}
 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

 EarthMagneticUDF (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 UDFBasemakeEMXYZ (const String &)
 Function to create an object. More...
 
static UDFBasemakeEMANG (const String &)
 
static UDFBasemakeEMLEN (const String &)
 
static UDFBasemakeIGRFXYZ (const String &)
 
static UDFBasemakeIGRFANG (const String &)
 
static UDFBasemakeIGRFLEN (const String &)
 
static UDFBasemakeIGRFLOS (const String &)
 
static UDFBasemakeIGRFLONG (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 Attributes

EarthMagneticEngine itsEngine
 
DirectionEngine itsDirectionEngine
 
EpochEngine itsEpochEngine
 
PositionEngine itsPositionEngine
 
FuncType itsType
 
Int itsValueType
 
MEarthMagnetic::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 EarthMagnetic conversions.

Intended use:

Public interface

Review Status

Test programs:
tMeas

Prerequisite

Synopsis

EarthMagneticUDF defines UDFs (user defined functions) that can be used in TaQL to convert Measures for earthMagnetics. 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.em (toref, em, time, pos)
meas.em (toref, em, time, pos)
For example,
meas.em ('J2000', 'IGRF', TIME, [[5d12m, 52deg, 11m], 'WGS84'])
TableExprNode time(const TableExprNode &node)
Definition: ExprNode.h:1580

All functions have data type double and unit Tesla.

Motivation

It makes it possible to handle measures in TaQL.

Definition at line 84 of file EarthMagneticUDF.h.

Member Enumeration Documentation

◆ FuncType

Define the possible function types.

Enumerator
EMXYZ 
EMANG 
EMLEN 
IGRFXYZ 
IGRFANG 
IGRFLEN 
IGRFLOS 
IGRFLONG 

Definition at line 88 of file EarthMagneticUDF.h.

Constructor & Destructor Documentation

◆ EarthMagneticUDF()

casacore::EarthMagneticUDF::EarthMagneticUDF ( FuncType  )
explicit

Create for the given function type.

Member Function Documentation

◆ getArrayDouble()

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

Reimplemented from casacore::UDFBase.

◆ getDouble()

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

Get the value.

Reimplemented from casacore::UDFBase.

◆ makeEMANG()

static UDFBase* casacore::EarthMagneticUDF::makeEMANG ( const String )
static

◆ makeEMLEN()

static UDFBase* casacore::EarthMagneticUDF::makeEMLEN ( const String )
static

◆ makeEMXYZ()

static UDFBase* casacore::EarthMagneticUDF::makeEMXYZ ( const String )
static

Function to create an object.

◆ makeIGRFANG()

static UDFBase* casacore::EarthMagneticUDF::makeIGRFANG ( const String )
static

◆ makeIGRFLEN()

static UDFBase* casacore::EarthMagneticUDF::makeIGRFLEN ( const String )
static

◆ makeIGRFLONG()

static UDFBase* casacore::EarthMagneticUDF::makeIGRFLONG ( const String )
static

◆ makeIGRFLOS()

static UDFBase* casacore::EarthMagneticUDF::makeIGRFLOS ( const String )
static

◆ makeIGRFXYZ()

static UDFBase* casacore::EarthMagneticUDF::makeIGRFXYZ ( const String )
static

◆ setup()

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

Setup the object.

Implements casacore::UDFBase.

Member Data Documentation

◆ itsDirectionEngine

DirectionEngine casacore::EarthMagneticUDF::itsDirectionEngine
private

Definition at line 114 of file EarthMagneticUDF.h.

◆ itsEngine

EarthMagneticEngine casacore::EarthMagneticUDF::itsEngine
private

Definition at line 113 of file EarthMagneticUDF.h.

◆ itsEpochEngine

EpochEngine casacore::EarthMagneticUDF::itsEpochEngine
private

Definition at line 115 of file EarthMagneticUDF.h.

◆ itsPositionEngine

PositionEngine casacore::EarthMagneticUDF::itsPositionEngine
private

Definition at line 116 of file EarthMagneticUDF.h.

◆ itsRefType

MEarthMagnetic::Types casacore::EarthMagneticUDF::itsRefType
private

Definition at line 119 of file EarthMagneticUDF.h.

◆ itsType

FuncType casacore::EarthMagneticUDF::itsType
private

Definition at line 117 of file EarthMagneticUDF.h.

◆ itsValueType

Int casacore::EarthMagneticUDF::itsValueType
private

Definition at line 118 of file EarthMagneticUDF.h.


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