TaQL UDFs for EarthMagnetic conversions. More...

#include <EarthMagneticUDF.h>

Inheritance diagram for casacore::EarthMagneticUDF:

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 UDFBase *	MakeUDFObject (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< 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< rownr_t > &rownrs)
	If needed, let the UDF re-create column objects for a selection of rows. More...

Static Public Member Functions
static UDFBase *	makeEMXYZ (const String &)
	Function to create an object. More...

static UDFBase *	makeEMANG (const String &)

static UDFBase *	makeEMLEN (const String &)

static UDFBase *	makeIGRFXYZ (const String &)

static UDFBase *	makeIGRFANG (const String &)

static UDFBase *	makeIGRFLEN (const String &)

static UDFBase *	makeIGRFLOS (const String &)

static UDFBase *	makeIGRFLONG (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
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

UDFBase

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'])

toref is a single constant string giving the EarthMagnetic reference type. It is not possible to use IGRF for the 'toref' type.
em is a value array followed by the reference type. Type IGRF is the IGRF, for which no value array should be given.

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

enum casacore::EarthMagneticUDF::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

casacore::EarthMagneticUDF::EarthMagneticUDF ( FuncType )

explicit

Create for the given function type.

Member Function Documentation

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

virtual

Reimplemented from casacore::UDFBase.

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

virtual

Get the value.

Reimplemented from casacore::UDFBase.

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

static

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

static

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

static

Function to create an object.

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

static

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

static

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

static

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

static

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

static

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

virtual

Setup the object.

Implements casacore::UDFBase.

Member Data Documentation

DirectionEngine casacore::EarthMagneticUDF::itsDirectionEngine

private

Definition at line 114 of file EarthMagneticUDF.h.

EarthMagneticEngine casacore::EarthMagneticUDF::itsEngine

private

Definition at line 113 of file EarthMagneticUDF.h.

EpochEngine casacore::EarthMagneticUDF::itsEpochEngine

private

Definition at line 115 of file EarthMagneticUDF.h.

PositionEngine casacore::EarthMagneticUDF::itsPositionEngine

private

Definition at line 116 of file EarthMagneticUDF.h.

MEarthMagnetic::Types casacore::EarthMagneticUDF::itsRefType

private

Definition at line 119 of file EarthMagneticUDF.h.

FuncType casacore::EarthMagneticUDF::itsType

private

Definition at line 117 of file EarthMagneticUDF.h.

Int casacore::EarthMagneticUDF::itsValueType

private

Definition at line 118 of file EarthMagneticUDF.h.

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

meas/MeasUDF/EarthMagneticUDF.h

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Intended use:

Review Status

Prerequisite

Synopsis

Motivation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation