Loading...
Searching...
No Matches
DopplerUDF.h
Go to the documentation of this file.
//# DopplerUDF.h: TaQL UDFs for Doppler conversions
//# Copyright (C) 2016
//# 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_DOPPLERUDF_H
#define MEAS_DOPPLERUDF_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/meas/MeasUDF/DopplerEngine.h>
#include <casacore/tables/TaQL/UDFBase.h>
namespace casacore {
// <summary>
// TaQL UDFs for Doppler 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>
// DopplerUDF defines UDFs (user defined functions) that can be used in TaQL
// to convert Measures for dopplers.
// 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 no unit.
// </synopsis>
// <motivation>
// It makes it possible to handle measures in TaQL.
// </motivation>
class DopplerUDF: public UDFBase
{
public:
// Create for the given function type.
explicit DopplerUDF();
// Function to create an object.
static UDFBase* makeDOPPLER (const String&);
// Setup the object.
virtual void setup (const Table&, const TaQLStyle&);
// Handle the value arguments as doppler or radial velocity.
// Optionally frequency is also allowed, in which case a rest frequency
// must also be given.
// It returns a pointer to the engine representing the given value.
BaseEngine* handleValueArgs (vector<TENShPtr>& args, uInt& argnr,
Bool allowFreq);
// Get the value.
virtual Double getDouble (const TableExprId& id);
virtual MArray<Double> getArrayDouble (const TableExprId& id);
private:
//# Data members.
DopplerEngine itsEngine;
MDoppler::Types itsRefType;
};
} //end namespace
#endif
casacore::BaseEngine
Definition BaseEngine.h:90
casacore::DopplerEngine
Definition DopplerEngine.h:97
casacore::DopplerUDF::getArrayDouble
virtual MArray< Double > getArrayDouble(const TableExprId &id)
casacore::DopplerUDF::makeDOPPLER
static UDFBase * makeDOPPLER(const String &)
Function to create an object.
casacore::DopplerUDF::DopplerUDF
DopplerUDF()
Create for the given function type.
casacore::DopplerUDF::setup
virtual void setup(const Table &, const TaQLStyle &)
Setup the object.
casacore::DopplerUDF::itsEngine
DopplerEngine itsEngine
Definition DopplerUDF.h:110
casacore::DopplerUDF::handleValueArgs
BaseEngine * handleValueArgs(vector< TENShPtr > &args, uInt &argnr, Bool allowFreq)
Handle the value arguments as doppler or radial velocity.
casacore::DopplerUDF::itsRefType
MDoppler::Types itsRefType
Definition DopplerUDF.h:111
casacore::DopplerUDF::getDouble
virtual Double getDouble(const TableExprId &id)
Get the value.
casacore::MArray
Definition MArray.h:68
casacore::MDoppler::Types
Types
Types of known MDopplers Warning: The order defines the order in the translation matrix FromTo in th...
Definition MDoppler.h:146
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::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40
casacore::Double
double Double
Definition aipstype.h:53