Loading...
Searching...
No Matches
EpochEngine.h
Go to the documentation of this file.
//# EpochEngine.h: Engine for TaQL UDF Epoch 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_EPOCHENGINE_H
#define MEAS_EPOCHENGINE_H
//# Includes
#include <casacore/casa/aips.h>
#include<casacore/meas/MeasUDF/MeasEngine.h>
#include <casacore/measures/Measures/MEpoch.h>
#include <casacore/measures/Measures/MCEpoch.h>
#include <casacore/measures/Measures/MeasConvert.h>
namespace casacore {
//# Forward declarations
class PositionEngine;
// <summary>
// Engine for TaQL UDF Epoch 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>
// EpochEngine defines Engines (user defined functions) that can be used in TaQL
// to convert Measures for epochs.
// In this way such derived values appear to be ordinary TaQL functions.
//
// In TaQL these functions can be called like:
// <srcblock>
// meas.epoch (toref, time, fromref)
// meas.last (time, fromref, pos, posref)
// For example,
// meas.epoch ('UTC', 1e9 s, 'WGS84')
// </srcblock>
// <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 functions have data type double and unit radian.
// A epoch can also be a table column which usually knows its type.
// It can also be an expression (e.g. EPOCH[0,]) which also knows the type.
// </synopsis>
// <motivation>
// It makes it possible to handle measures in TaQL.
// </motivation>
class EpochEngine: public MeasEngine<MEpoch>
{
public:
EpochEngine();
virtual ~EpochEngine();
// Tell if the fraction has to be used for sidereal times.
Bool sidFrac() const
{ return itsSidFrac; }
// Get the values.
Array<Double> getArrayDouble (const TableExprId& id);
// Get the epochs.
Array<MEpoch> getEpochs (const TableExprId& id);
// Handle the argument(s) giving the input epochs and reference type.
// The epoch can be a column in a table.
void handleEpoch (std::vector<TENShPtr>& args,
uInt& argnr);
// Set the MeasConvert object.
void setConverter (MEpoch::Types toType, Bool sidFrac);
// Set the possible position engine.
// It can be done only once.
void setPositionEngine (PositionEngine& engine);
private:
// Strip a possible prefix from the epoch type.
virtual String stripMeasType (const String& type);
virtual void handleValues (TableExprNode& operand,
const TableExprId& id,
Array<MEpoch>& epochs);
//# Data members.
Bool itsSidFrac; //# T = fraction for sidereal
MeasFrame itsFrame; //# frame used by converter
MEpoch::Convert itsConverter;
PositionEngine* itsPositionEngine;
};
} //end namespace
#endif
casacore::type
casacore::Array
Definition Array.h:155
casacore::EpochEngine::itsPositionEngine
PositionEngine * itsPositionEngine
Definition EpochEngine.h:128
casacore::EpochEngine::setPositionEngine
void setPositionEngine(PositionEngine &engine)
Set the possible position engine.
casacore::EpochEngine::handleValues
virtual void handleValues(TableExprNode &operand, const TableExprId &id, Array< MEpoch > &epochs)
Let a derive class handle the values.
casacore::EpochEngine::getEpochs
Array< MEpoch > getEpochs(const TableExprId &id)
Get the epochs.
casacore::EpochEngine::~EpochEngine
virtual ~EpochEngine()
casacore::EpochEngine::itsSidFrac
Bool itsSidFrac
Definition EpochEngine.h:125
casacore::EpochEngine::getArrayDouble
Array< Double > getArrayDouble(const TableExprId &id)
Get the values.
casacore::EpochEngine::itsFrame
MeasFrame itsFrame
Definition EpochEngine.h:126
casacore::EpochEngine::setConverter
void setConverter(MEpoch::Types toType, Bool sidFrac)
Set the MeasConvert object.
casacore::EpochEngine::itsConverter
MEpoch::Convert itsConverter
Definition EpochEngine.h:127
casacore::EpochEngine::handleEpoch
void handleEpoch(std::vector< TENShPtr > &args, uInt &argnr)
Handle the argument(s) giving the input epochs and reference type.
casacore::EpochEngine::stripMeasType
virtual String stripMeasType(const String &type)
Strip a possible prefix from the epoch type.
casacore::EpochEngine::EpochEngine
EpochEngine()
casacore::EpochEngine::sidFrac
Bool sidFrac() const
Tell if the fraction has to be used for sidereal times.
Definition EpochEngine.h:96
casacore::MEpoch::Types
Types
Types of known MEpochs Caution: The order defines the order in the translation matrix in the MCEpoch...
Definition MEpoch.h:114
casacore::MEpoch::Convert
MeasConvert< MEpoch > Convert
Measure Convert (i.e.
Definition MEpoch.h:155
casacore::MeasEngine< MEpoch >::MeasEngine
MeasEngine()
Definition MeasEngine.h:93
casacore::MeasFrame
Definition MeasFrame.h:151
casacore::PositionEngine
Definition PositionEngine.h:125
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
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
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40