Loading...
Searching...
No Matches
DirectionUDF.h
Go to the documentation of this file.
//# DirectionUDF.h: TaQL UDFs for Direction conversions
//# Copyright (C) 2011
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef MEAS_DIRECTIONUDF_H
#define MEAS_DIRECTIONUDF_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/meas/MeasUDF/DirectionEngine.h>
#include <casacore/meas/MeasUDF/EpochEngine.h>
#include <casacore/meas/MeasUDF/PositionEngine.h>
#include <casacore/tables/TaQL/UDFBase.h>
namespace casacore {
// <summary>
// TaQL UDFs for Direction conversions.
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="tMeas.cc">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> UDFBase
// </prerequisite>
// <synopsis>
// DirectionUDF defines UDFs (user defined functions) that can be used in TaQL
// to convert Measures for directions.
// 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:
// <srcblock>
// 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)
// </srcblock>
// <ul>
// <li>
// <src>toref</src> is a single constant string.
// <li>
// <src>dir</src> 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.
// </ul>
// All functions have data type double and unit radian.
// </synopsis>
// <motivation>
// It makes it possible to handle measures in TaQL.
// </motivation>
class DirectionUDF: public UDFBase
{
public:
// Define the possible function types.
enum FuncType {DIRECTION, DIRCOS, HADEC, AZEL, APP, J2000, B1950,
ECLIPTIC, GALACTIC, SUPERGALACTIC, ITRF};
// Create for the given function type.
// The Bools tell if rise/set times have to be calculated.
explicit DirectionUDF (FuncType, Bool riseSet=False);
// Function to create an object.
static UDFBase* makeDIR (const String&);
static UDFBase* makeDIRCOS (const String&);
static UDFBase* makeHADEC (const String&);
static UDFBase* makeAZEL (const String&);
static UDFBase* makeAPP (const String&);
static UDFBase* makeJ2000 (const String&);
static UDFBase* makeB1950 (const String&);
static UDFBase* makeECL (const String&);
static UDFBase* makeGAL (const String&);
static UDFBase* makeSGAL (const String&);
static UDFBase* makeITRF (const String&);
static UDFBase* makeRISESET (const String&);
// Setup the object.
virtual void setup (const Table&, const TaQLStyle&);
// Get the value.
virtual Double getDouble (const TableExprId& id);
virtual MArray<Double> getArrayDouble (const TableExprId& id);
virtual MArray<MVTime> getArrayDate (const TableExprId& id);
private:
//# Data members.
DirectionEngine itsEngine;
EpochEngine itsEpochEngine;
PositionEngine itsPositionEngine;
FuncType itsType;
MDirection::Types itsRefType;
Bool itsRiseSet; //# True = calculate rise/set time
};
} //end namespace
#endif
casacore::DirectionEngine
Definition DirectionEngine.h:140
casacore::DirectionUDF::makeGAL
static UDFBase * makeGAL(const String &)
casacore::DirectionUDF::itsEpochEngine
EpochEngine itsEpochEngine
Definition DirectionUDF.h:123
casacore::DirectionUDF::makeITRF
static UDFBase * makeITRF(const String &)
casacore::DirectionUDF::makeB1950
static UDFBase * makeB1950(const String &)
casacore::DirectionUDF::itsPositionEngine
PositionEngine itsPositionEngine
Definition DirectionUDF.h:124
casacore::DirectionUDF::itsRefType
MDirection::Types itsRefType
Definition DirectionUDF.h:126
casacore::DirectionUDF::makeJ2000
static UDFBase * makeJ2000(const String &)
casacore::DirectionUDF::makeAPP
static UDFBase * makeAPP(const String &)
casacore::DirectionUDF::makeAZEL
static UDFBase * makeAZEL(const String &)
casacore::DirectionUDF::setup
virtual void setup(const Table &, const TaQLStyle &)
Setup the object.
casacore::DirectionUDF::makeDIRCOS
static UDFBase * makeDIRCOS(const String &)
casacore::DirectionUDF::itsRiseSet
Bool itsRiseSet
Definition DirectionUDF.h:127
casacore::DirectionUDF::DirectionUDF
DirectionUDF(FuncType, Bool riseSet=False)
Create for the given function type.
casacore::DirectionUDF::getArrayDouble
virtual MArray< Double > getArrayDouble(const TableExprId &id)
casacore::DirectionUDF::makeSGAL
static UDFBase * makeSGAL(const String &)
casacore::DirectionUDF::makeDIR
static UDFBase * makeDIR(const String &)
Function to create an object.
casacore::DirectionUDF::itsEngine
DirectionEngine itsEngine
Definition DirectionUDF.h:122
casacore::DirectionUDF::itsType
FuncType itsType
Definition DirectionUDF.h:125
casacore::DirectionUDF::getArrayDate
virtual MArray< MVTime > getArrayDate(const TableExprId &id)
casacore::DirectionUDF::makeECL
static UDFBase * makeECL(const String &)
casacore::DirectionUDF::makeRISESET
static UDFBase * makeRISESET(const String &)
casacore::DirectionUDF::FuncType
FuncType
Define the possible function types.
Definition DirectionUDF.h:91
casacore::DirectionUDF::ECLIPTIC
@ ECLIPTIC
Definition DirectionUDF.h:92
casacore::DirectionUDF::DIRCOS
@ DIRCOS
Definition DirectionUDF.h:91
casacore::DirectionUDF::ITRF
@ ITRF
Definition DirectionUDF.h:92
casacore::DirectionUDF::HADEC
@ HADEC
Definition DirectionUDF.h:91
casacore::DirectionUDF::APP
@ APP
Definition DirectionUDF.h:91
casacore::DirectionUDF::DIRECTION
@ DIRECTION
Definition DirectionUDF.h:91
casacore::DirectionUDF::AZEL
@ AZEL
Definition DirectionUDF.h:91
casacore::DirectionUDF::B1950
@ B1950
Definition DirectionUDF.h:91
casacore::DirectionUDF::GALACTIC
@ GALACTIC
Definition DirectionUDF.h:92
casacore::DirectionUDF::SUPERGALACTIC
@ SUPERGALACTIC
Definition DirectionUDF.h:92
casacore::DirectionUDF::J2000
@ J2000
Definition DirectionUDF.h:91
casacore::DirectionUDF::getDouble
virtual Double getDouble(const TableExprId &id)
Get the value.
casacore::DirectionUDF::makeHADEC
static UDFBase * makeHADEC(const String &)
casacore::EpochEngine
Definition EpochEngine.h:89
casacore::MArray
Definition MArray.h:68
casacore::MDirection::Types
Types
Types of known MDirections Warning: The order defines the order in the translation matrix FromTo in ...
Definition MDirection.h:185
casacore::PositionEngine
Definition PositionEngine.h:125
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::TaQLStyle
Definition TaQLStyle.h:63
casacore::TableExprId
Definition TableExprId.h:95
casacore::Table
Definition Table.h:157
casacore::UDFBase::UDFBase
UDFBase()
Only default constructor is needed.
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::False
const Bool False
Definition aipstype.h:42
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40
casacore::Double
double Double
Definition aipstype.h:53