Loading...
Searching...
No Matches
RadialVelocityEngine.h
Go to the documentation of this file.
//# RadialVelocityEngine.h: Engine for TaQL UDF RadialVelocity 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_RADIALVELOCITYENGINE_H
#define MEAS_RADIALVELOCITYENGINE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/meas/MeasUDF/MeasEngine.h>
#include <casacore/measures/Measures/MRadialVelocity.h>
#include <casacore/measures/Measures/MCRadialVelocity.h>
#include <casacore/measures/Measures/MeasConvert.h>
namespace casacore {
//# Forward declarations
class DopplerEngine;
class DirectionEngine;
class EpochEngine;
class PositionEngine;
// <summary>
// Engine for TaQL UDF RadialVelocity conversions
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="tMeas.cc">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> EngineBase
// </prerequisite>
// <synopsis>
// RadialVelocityEngine defines Engines (user defined functions) that can be used
// in TaQL to convert Measures for radial velocities.
// In this way such derived values appear to be ordinary TaQL functions.
//
// RadialVelocity conversions require a MeasFrame containing sky direction,
// epoch and position on earth.
// In TaQL these functions can be called like:
// <srcblock>
// meas.rv ('TOPO', 1 'm/s', 'LSRK', 'CasA', date(),
// [1e6m,1e6m,1e6m], 'WGS84')
// </srcblock>
// which converts the radial velocity from LSRK to TOPO.
// <ul>
// <li>
// <src>toref</src> is a single constant string.
// <li>
// <src>pos</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 such functions return data with type double and unit Hz.
//
// Radial velocities can be given like:
// [v1,v2,...], fromRef
// where fromRef is the reference type.
//
// A radial velocity can also be a table column which usually knows its type.
// It can also be an expression (e.g. RADIALVELOCITY[0,]) which also knows the type.
// </synopsis>
// <motivation>
// It makes it possible to handle measures in TaQL.
// </motivation>
class RadialVelocityEngine: public MeasEngine<MRadialVelocity>
{
public:
RadialVelocityEngine();
// Get the values.
Array<Double> getArrayDouble (const TableExprId& id);
// Get the radial velocities.
Array<MRadialVelocity> getRadialVelocities (const TableExprId& id);
// Handle the argument(s) giving the input radial velocities and reference type.
// The radial velocity can be a column in a table.
// If 'proper' is True, it is tested if a proper radial velocity is given
// (with proper unit and/or type). If not. False is returned.
// If 'proper' is False, the value is always considered as radial velocity.
void handleRadialVelocity (std::vector<TENShPtr>& args,
uInt& argnr);
// Set the MeasConvert object.
void setConverter (MRadialVelocity::Types toType);
// Set the possible doppler engine.
// It can be done only once.
void setDopplerEngine (DopplerEngine& engine);
// Set the possible direction engine.
// It can be done only once.
void setDirectionEngine (DirectionEngine& engine);
// Set the possible epoch engine.
// It can be done only once.
void setEpochEngine (EpochEngine& engine);
// Set the possible position engine.
// It can be done only once.
void setPositionEngine (PositionEngine& engine);
private:
virtual void handleValues (TableExprNode& operand,
const TableExprId& id,
Array<MRadialVelocity>& radialVelocities);
//# Data members.
MeasFrame itsFrame; //# frame used by converter
MRadialVelocity::Convert itsConverter;
DopplerEngine* itsDopplerEngine;
DirectionEngine* itsDirectionEngine;
EpochEngine* itsEpochEngine;
PositionEngine* itsPositionEngine;
};
} //end namespace
#endif
casacore::Array
Definition Array.h:155
casacore::DirectionEngine
Definition DirectionEngine.h:140
casacore::DopplerEngine
Definition DopplerEngine.h:97
casacore::EpochEngine
Definition EpochEngine.h:89
casacore::MRadialVelocity::Convert
MeasConvert< MRadialVelocity > Convert
Measure conversion use (i.e.
Definition MRadialVelocity.h:172
casacore::MRadialVelocity::Types
Types
Types of known MRadialVelocity Warning: The order defines the order in the translation matrix FromTo...
Definition MRadialVelocity.h:149
casacore::MeasEngine< MRadialVelocity >::MeasEngine
MeasEngine()
Definition MeasEngine.h:93
casacore::MeasFrame
Definition MeasFrame.h:151
casacore::PositionEngine
Definition PositionEngine.h:125
casacore::RadialVelocityEngine::setConverter
void setConverter(MRadialVelocity::Types toType)
Set the MeasConvert object.
casacore::RadialVelocityEngine::getArrayDouble
Array< Double > getArrayDouble(const TableExprId &id)
Get the values.
casacore::RadialVelocityEngine::itsFrame
MeasFrame itsFrame
Definition RadialVelocityEngine.h:140
casacore::RadialVelocityEngine::itsDopplerEngine
DopplerEngine * itsDopplerEngine
Definition RadialVelocityEngine.h:142
casacore::RadialVelocityEngine::itsConverter
MRadialVelocity::Convert itsConverter
Definition RadialVelocityEngine.h:141
casacore::RadialVelocityEngine::RadialVelocityEngine
RadialVelocityEngine()
casacore::RadialVelocityEngine::itsEpochEngine
EpochEngine * itsEpochEngine
Definition RadialVelocityEngine.h:144
casacore::RadialVelocityEngine::handleRadialVelocity
void handleRadialVelocity(std::vector< TENShPtr > &args, uInt &argnr)
Handle the argument(s) giving the input radial velocities and reference type.
casacore::RadialVelocityEngine::setDopplerEngine
void setDopplerEngine(DopplerEngine &engine)
Set the possible doppler engine.
casacore::RadialVelocityEngine::setPositionEngine
void setPositionEngine(PositionEngine &engine)
Set the possible position engine.
casacore::RadialVelocityEngine::setEpochEngine
void setEpochEngine(EpochEngine &engine)
Set the possible epoch engine.
casacore::RadialVelocityEngine::getRadialVelocities
Array< MRadialVelocity > getRadialVelocities(const TableExprId &id)
Get the radial velocities.
casacore::RadialVelocityEngine::itsPositionEngine
PositionEngine * itsPositionEngine
Definition RadialVelocityEngine.h:145
casacore::RadialVelocityEngine::itsDirectionEngine
DirectionEngine * itsDirectionEngine
Definition RadialVelocityEngine.h:143
casacore::RadialVelocityEngine::setDirectionEngine
void setDirectionEngine(DirectionEngine &engine)
Set the possible direction engine.
casacore::RadialVelocityEngine::handleValues
virtual void handleValues(TableExprNode &operand, const TableExprId &id, Array< MRadialVelocity > &radialVelocities)
Let a derive class handle the values.
casacore::TableExprId
Definition TableExprId.h:95
casacore::TableExprNode
Definition ExprNode.h:154
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uInt
unsigned int uInt
Definition aipstype.h:49