casacore::EpochUDF Class Reference

TaQL UDFs for Epoch conversions. More...

#include <EpochUDF.h>

Inheritance diagram for casacore::EpochUDF:

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

Public Member Functions
	EpochUDF (FuncType)
virtual void	setup (const Table &, const TaQLStyle &)
	Setup the object. More...
virtual Double	getDouble (const TableExprId &id)
	Get the value. More...
virtual MArray< Double >	getArrayDouble (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< Bool >	getArrayBool (const TableExprId &id)
virtual MArray< Int64 >	getArrayInt (const TableExprId &id)
virtual MArray< DComplex >	getArrayDComplex (const TableExprId &id)
virtual MArray< String >	getArrayString (const TableExprId &id)
virtual MArray< MVTime >	getArrayDate (const TableExprId &id)
const String &	getUnit () const
	Get the unit. More...
const Record &	getAttributes () 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 IPosition &	shape () 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< uInt > &rownrs)
	If needed, let the UDF re-create column objects for a selection of rows. More...

Static Public Member Functions
static UDFBase *	makeEPOCH (const String &)
	Function to create an object. More...
static UDFBase *	makeLAST (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 UDFBase *	createUDF (const String &name, const TaQLStyle &style)
	Create a UDF object (thread-safe). More...

Private Attributes
EpochEngine	itsEngine
PositionEngine	itsPositionEngine
FuncType	itsType
MEpoch::Types	itsRefType
Bool	itsSidFrac

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< uInt > &rownrs)
	Let a derived class recreate its column objects in case a selection has to be applied. More...

Detailed Description

TaQL UDFs for Epoch conversions.

Intended use:

Public interface

Review Status

Test programs:

tMeas

Prerequisite

• UDFBase

Synopsis

EpochUDF defines UDFs (user defined functions) that can be used in TaQL to convert Measures for epochs. Special functions exist to convert to local sidereal time. In this way such derived values appear to be ordinary TaQL functions.

A function is called like:

meas.epoch (toref, epoch, fromref, pos, posref)
For example,
meas.dir ('APP', 'MOON', POSITION, TIME)

• toref is a single constant string.
• dir can have various value types. A single numeric array is a series of RA,DEC in J2000. If given as a set, the last argument of the set can be the reference types of the values in the set. The values can be strings (indicating planetary objects) or value pairs giving lon,lat. The default reference type is J2000.

All functions have data type double and unit radian.

Motivation

It makes it possible to handle measures in TaQL.

Definition at line 82 of file EpochUDF.h.

Member Enumeration Documentation

enum casacore::EpochUDF::FuncType

Define the possible function types.

Enumerator
EPOCH
LAST

Definition at line 86 of file EpochUDF.h.

Constructor & Destructor Documentation

casacore::EpochUDF::EpochUDF ( FuncType  )

explicit

Member Function Documentation

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

virtual

Reimplemented from casacore::UDFBase.

virtual Double casacore::EpochUDF::getDouble ( const TableExprId &  id )

virtual

Get the value.

Reimplemented from casacore::UDFBase.

static UDFBase* casacore::EpochUDF::makeEPOCH ( const String &  )

static

Function to create an object.

static UDFBase* casacore::EpochUDF::makeLAST ( const String &  )

static

virtual void casacore::EpochUDF::setup ( const Table &  , const TaQLStyle &    )

virtual

Setup the object.

Implements casacore::UDFBase.

Member Data Documentation

EpochEngine casacore::EpochUDF::itsEngine

private

Definition at line 103 of file EpochUDF.h.

PositionEngine casacore::EpochUDF::itsPositionEngine

private

Definition at line 104 of file EpochUDF.h.

MEpoch::Types casacore::EpochUDF::itsRefType

private

Definition at line 106 of file EpochUDF.h.

Bool casacore::EpochUDF::itsSidFrac

private

Definition at line 107 of file EpochUDF.h.

FuncType casacore::EpochUDF::itsType

private

Definition at line 105 of file EpochUDF.h.

---

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

• casa/casacore/meas/MeasUDF/EpochUDF.h