Loading...
Searching...
No Matches
FrequencyEngine.h
Go to the documentation of this file.
//# FrequencyEngine.h: Engine for TaQL UDF Frequency 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_FREQUENCYENGINE_H
#define MEAS_FREQUENCYENGINE_H
//# Includes
#include <casacore/casa/aips.h>
#include<casacore/meas/MeasUDF/MeasEngine.h>
#include <casacore/measures/Measures/MFrequency.h>
#include <casacore/measures/Measures/MCFrequency.h>
#include <casacore/measures/Measures/MeasConvert.h>
namespace casacore {
//# Forward declarations
class DopplerEngine;
class RadialVelocityEngine;
class DirectionEngine;
class EpochEngine;
class PositionEngine;
// <summary>
// Engine for TaQL UDF Frequency 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>
// FrequencyEngine defines Engines (user defined functions) that can be used
// in TaQL to convert Measures for frequencies.
// In this way such derived values appear to be ordinary TaQL functions.
//
// Frequency conversions require a MeasFrame containing sky direction,
// epoch and position on earth.
// In TaQL these functions can be called like:
// <srcblock>
// meas.freq ('TOPO', 1GHz, 'LSRK', 'CasA', date(),
// [1e6m,1e6m,1e6m], 'WGS84')
// </srcblock>
// which converts the frequency 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.
//
// Frequencies can be given like:
// [f1,f2,...], fromRef
// where fromRef is the reference type.
//
// A frequency can also be a table column which usually knows its type.
// It can also be an expression (e.g. FREQUENCY[0,]) which also knows the type.
// </synopsis>
// <motivation>
// It makes it possible to handle measures in TaQL.
// </motivation>
class FrequencyEngine: public MeasEngine<MFrequency>
{
public:
FrequencyEngine();
virtual ~FrequencyEngine();
// Get the values.
Array<Double> getArrayDouble (const TableExprId& id, int type);
// Get the frequencies.
Array<MFrequency> getFrequencies (const TableExprId& id);
// Handle the argument(s) giving the input frequencies and reference type.
// The frequency can be a column in a table.
void handleFrequency (std::vector<TENShPtr>& args,
uInt& argnr);
// Set the MeasConvert object.
void setConverter (MFrequency::Types toType);
// Set the possible doppler engine.
// It can be done only once.
void setDopplerEngine (DopplerEngine& engine);
// Set the possible radial velocity engine.
// It can be done only once.
void setRadVelEngine (RadialVelocityEngine& 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<MFrequency>& frequencies);
//# Data members.
MeasFrame itsFrame; //# frame used by converter
MeasFrame itsRVFrame; //# frame used for radial velocities
MFrequency::Convert itsConverter;
EpochEngine* itsEpochEngine;
PositionEngine* itsPositionEngine;
DirectionEngine* itsDirectionEngine;
DopplerEngine* itsDopplerEngine;
RadialVelocityEngine* itsRadVelEngine;
};
} //end namespace
#endif
casacore::type
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::FrequencyEngine::setPositionEngine
void setPositionEngine(PositionEngine &engine)
Set the possible position engine.
casacore::FrequencyEngine::setDirectionEngine
void setDirectionEngine(DirectionEngine &engine)
Set the possible direction engine.
casacore::FrequencyEngine::setConverter
void setConverter(MFrequency::Types toType)
Set the MeasConvert object.
casacore::FrequencyEngine::handleValues
virtual void handleValues(TableExprNode &operand, const TableExprId &id, Array< MFrequency > &frequencies)
Let a derive class handle the values.
casacore::FrequencyEngine::getFrequencies
Array< MFrequency > getFrequencies(const TableExprId &id)
Get the frequencies.
casacore::FrequencyEngine::~FrequencyEngine
virtual ~FrequencyEngine()
casacore::FrequencyEngine::handleFrequency
void handleFrequency(std::vector< TENShPtr > &args, uInt &argnr)
Handle the argument(s) giving the input frequencies and reference type.
casacore::FrequencyEngine::itsRVFrame
MeasFrame itsRVFrame
Definition FrequencyEngine.h:145
casacore::FrequencyEngine::FrequencyEngine
FrequencyEngine()
casacore::FrequencyEngine::itsDirectionEngine
DirectionEngine * itsDirectionEngine
Definition FrequencyEngine.h:149
casacore::FrequencyEngine::itsConverter
MFrequency::Convert itsConverter
Definition FrequencyEngine.h:146
casacore::FrequencyEngine::setDopplerEngine
void setDopplerEngine(DopplerEngine &engine)
Set the possible doppler engine.
casacore::FrequencyEngine::itsRadVelEngine
RadialVelocityEngine * itsRadVelEngine
Definition FrequencyEngine.h:151
casacore::FrequencyEngine::itsFrame
MeasFrame itsFrame
Definition FrequencyEngine.h:144
casacore::FrequencyEngine::itsEpochEngine
EpochEngine * itsEpochEngine
Definition FrequencyEngine.h:147
casacore::FrequencyEngine::getArrayDouble
Array< Double > getArrayDouble(const TableExprId &id, int type)
Get the values.
casacore::FrequencyEngine::setRadVelEngine
void setRadVelEngine(RadialVelocityEngine &engine)
Set the possible radial velocity engine.
casacore::FrequencyEngine::itsPositionEngine
PositionEngine * itsPositionEngine
Definition FrequencyEngine.h:148
casacore::FrequencyEngine::itsDopplerEngine
DopplerEngine * itsDopplerEngine
Definition FrequencyEngine.h:150
casacore::FrequencyEngine::setEpochEngine
void setEpochEngine(EpochEngine &engine)
Set the possible epoch engine.
casacore::MFrequency::Convert
MeasConvert< MFrequency > Convert
Measure conversion use (i.e.
Definition MFrequency.h:201
casacore::MFrequency::Types
Types
Types of known MFrequencies Warning: The order defines the order in the translation matrix FromTo in...
Definition MFrequency.h:173
casacore::MeasEngine< MFrequency >::MeasEngine
MeasEngine()
Definition MeasEngine.h:93
casacore::MeasFrame
Definition MeasFrame.h:151
casacore::PositionEngine
Definition PositionEngine.h:125
casacore::RadialVelocityEngine
Definition RadialVelocityEngine.h:97
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