MeasConvert.h

Go to the documentation of this file.

//# MeasConvert.h: Conversion of Measures
//# Copyright (C) 1995,1996,1997,1998,1999,2000,2001
//# 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: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
//#
//# $Id: MeasConvert.h 21024 2011-03-01 11:46:18Z gervandiepen $

#ifndef MEASURES_MEASCONVERT_H
#define MEASURES_MEASCONVERT_H

//# Includes
#include <casa/aips.h>
#include <casa/Containers/Block.h>
#include <measures/Measures/MConvertBase.h>
#include <casa/Quanta/Quantum.h>
#include <measures/Measures/Measure.h>
namespace casa { //# NAMESPACE CASA - BEGIN


//# Forward Declarations
class MCBase;
class MeasVal;

//# Typedefs

//# Constants

// <summary> Conversion of Measures </summary>

// <use visibility=export>

// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tMeasure" demos="">
// </reviewed>

// <prerequisite>
//   <li> <linkto class=Measure>Measure</linkto> class 
//   <li> <linkto class=MRBase>MeasRef</linkto> base class 
//   <li> <linkto class=MConvertBase>MConvertBase</linkto> class 
//   <li> <linkto class=Quantum>Quantum</linkto> class 
// </prerequisite>
//
// <etymology>
// </etymology>
//
// <synopsis>
// MeasConvert can convert a Measure to the same type of Measure in a
// different reference frame. The MeasConvert is a templated class, but
// has typedefs, which are strongly recommended to be used,
// for the allowed conversions, like <src>MEpoch::Convert.</src><br>
// The basic operation is to create a MeasConvert with either of:
// <ul>
//   <li> MEpoch::Convert(MEpoch, MEpoch::Ref), where the 
//      <linkto class=MEpoch>MEpoch</linkto> is a template for subsequent
//      conversions, i.e. it will remember the value (with its reference) and 
//      the <linkto class=MeasRef>MeasRef</linkto> output reference.
//   <li> MEpoch::Convert(MEpoch) with a subsequent setOut(MEpoch::Ref)
//   <li> MEpoch::Convert(MEpoch::Ref in, MEpoch::Ref out) is a template for
//       conversions from the input reference to the output reference. The
//      'template' model used is the default value for the Measure, with
//      no units. 
//   <li> MEpoch::Convert(Unit, MEpoch::Ref in, MEpoch::Ref out) is a
//       template for
//       conversions from the input reference to the output reference. The
//      'template' model used is the default value for the Measure, with
//      the default units as specified.
//   <li> MEpoch::Convert() with a setModel(MEpoch) and setOut().
// </ul>
// An empty MeasRef argument indicates no conversion will be attempted<br>.
// The constructor, and set functions, analyse the 'template' Measure and the
// output reference frame, and construct a pointer (in practice a list
// of pointers to bypass the necessity of creating too many conversion
// functions) to a conversion routine.
// 
// An <src>isNOP()</src> function is available to test if the created
// conversion engine is empty.
//
// Actual conversions are done with the () operator, which produces a new
// MEpoch (or other appropiate Measure).<br>
// Possible arguments are (MVEpoch is used here generic, and indicates the
// internal format of a Measure; possibly, to make sure distinction between
// values with and without units possible, even simple Measures will
// have their own internal class format, e.g. MVDouble. 
// The possible arguments to the () conversion operator are (again Epoch
// is used for the generic Measure):
// <ul>
//   <li> (MEpoch, MEpoch::Ref): will create a new conversion method, and use 
//      it to produce the result of converting the MEpoch to the specified
//      frame
//    <li> (MEpoch): will create a new conversion method from the
//      MEpoch to the MeasRef belonging to the MeasConvert
//    <li> (Quantity): will use the conversion chain deduced from the
//      MEpoch model in the definition of MeasConvert, and will convert the
//      Quantity
//    <li> (Quantum<Vector<Double> >) as previous
//    <li> (Double): will use the units (if present) as specified in the
//              MeasConvert object to construct the internal value
//               to be converted
//    <li> (Vector<Double> >): as previous
// </ul>
// Float versions will be produced if necessary.<br>
// The conversion analyser expects that all Measure classes have a set
// of routines to do the actual analysing and conversion.
// (see <linkto class=MCBase>MCBase</linkto> class for how this is done in
// practice).<br>
// If the standard conversion is not sufficient, additional methods can be
// added at the end of the list with the <src>addMethod()</src> member
// function (for real pros).<br>
// </synopsis>
//
// <example>
// See <linkto class=Measure>Measure</linkto> for an example
// </example>
//
// <motivation>
// Conversion of Measures will in general be done on a series of values.
// Separating the analysis of the calculations necessary for the conversion
// from the actual conversion could speed up the process.
// </motivation>
//
// <todo asof="1999/09/24">
// </todo>

template<class M> class MeasConvert : public MConvertBase {

public:

  //# Friends

  //# Constructors
  // <note role=tip> In the following constructors and other functions, all 
  // <em>MeasRef</em> can be replaced with simple <src>Measure::TYPE</src>
  // where no offsets or frames are needed in the reference.</note>
  // Construct an empty MeasConvert. It is not usable, unless a setModel, and
  // probably a setOut has been done.
  MeasConvert();
  // Copy constructor
  MeasConvert(const MeasConvert<M> &other);
  // Copy assignment
  MeasConvert<M> &operator=(const MeasConvert<M> &other);
  
  // Construct a conversion for the specified Measure and reference
  // <group>
  MeasConvert(const M &ep);
  MeasConvert(const M &ep, const typename M::Ref &mr);
  MeasConvert(const Measure &ep, const typename M::Ref &mr);
  MeasConvert(const M &ep, typename M::Types mr);
  MeasConvert(const Measure &ep, typename M::Types mr);
  MeasConvert(const typename M::Ref &mrin, const typename M::Ref &mr);
  MeasConvert(const typename M::Ref &mrin, typename M::Types mr);
  MeasConvert(typename M::Types mrin, const typename M::Ref &mr);
  MeasConvert(typename M::Types mrin, typename M::Types mr);
  MeasConvert(const Unit &inunit, const typename M::Ref &mrin, 
              const typename M::Ref &mr);
  MeasConvert(const Unit &inunit, const typename M::Ref &mrin, 
              typename M::Types mr);
  MeasConvert(const Unit &inunit, typename M::Types mrin, 
              const typename M::Ref &mr);
  MeasConvert(const Unit &inunit, typename M::Types mrin, 
              typename M::Types mr);
  // </group>
  
  //# Destructor
  ~MeasConvert();
  
  //# Operators
  // The actual conversion operations
  // <group>
  // Convert model Measure to output frame
  const M &operator()();
  const M &operator()(Double val);
  const M &operator()(const Vector<Double> &val);
  const M &operator()(const Quantum<Double> &val);
  const M &operator()(const Quantum<Vector<Double> > &val);
  const M &operator()(const typename M::MVType &val);
  const M &operator()(const MeasVal *val);
  const M &operator()(const M &val);
  const M &operator()(const M &val, const typename M::Ref &mr);
  const M &operator()(const M &val, typename M::Types mr);
  const M &operator()(const typename M::Ref &mr);
  const M &operator()(typename M::Types mr);
  // </group>
  
  //# General Member Functions
  // Set a new model for the conversion
  virtual void setModel(const Measure &val);
  // Set a new output reference
  // <group>
  void setOut(const typename M::Ref &mr);
  void setOut(typename M::Types mr);
  // </group>
  // Set a new model and reference
  // <group>
  void set(const M &val, const typename M::Ref &mr);
  void set(const M &val, typename M::Types mr);
  // </group>
  // Set a new model value only
  virtual void set(const MeasValue &val);
  // Set a new model unit only
  virtual void set(const Unit &inunit);
  
  // Add a method (Note: uInt should be an enum from the appropiate Measure)
  virtual void addMethod(uInt method);
  // Add the frame type (Note: tp should be an MeasFrame::FrameType)
  virtual void addFrameType(uInt tp);
  // Get number of methods
  virtual Int nMethod() const;
  // Get method
  virtual uInt getMethod(uInt which) const;
  // Is the conversion engine empty?
  Bool isNOP() { return crout.nelements() == 0; }
  // Print conversion engine
  virtual void print(ostream &os) const;
  
private:
  //# Data
  // The model template Measure
  Measure *model;
  // The model unit to be used in conversions
  Unit unit;
  // The output reference
  typename M::Ref outref;
  // The input offset
  typename M::MVType *offin;
  // The output offset
  typename M::MVType *offout;
  // Vector of conversion routines (length variable)
  Block<uInt> crout;
  // Coded (with MeasFrame::FrameTypes) frames used in conversion
  uInt crtype;
  // Local conversion data
  MCBase *cvdat;
  // Cyclic buffer for return values
  // <group>
  // Current pointer
  Int lres;
  M *result[4];
  // </group>
  // Local variables that can be used in conversion
  // <group>
  typename M::MVType *locres;
  // </group>
  
  //# Member functions
  // Initialise pointers
  void init();
  // Copy a MeasConvert
  void copy(const MeasConvert<M> &other);
  // Clear self
  void clear();
  // Create the conversion routine chain
  void create();
  // Convert a value
  // <group>
  const typename M::MVType &convert();
  const typename M::MVType &convert(const typename M::MVType &val);
  // </group>
};

//# Global functions


} //# NAMESPACE CASA - END

#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <measures/Measures/MeasConvert.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif