MCFrequency.h

Go to the documentation of this file.

// # MCFrequency.h: MFrequency conversion routines
// # Copyright (C) 1995,1996,1997,1998,1999,2000,2002,2003
// # 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 MEASURES_MCFREQUENCY_H
#define MEASURES_MCFREQUENCY_H
 
// # Includes
#include <casacore/casa/aips.h>
#include <casacore/measures/Measures/MeasBase.h>
#include <casacore/measures/Measures/MeasRef.h>
#include <casacore/measures/Measures/MCBase.h>
#include <casacore/measures/Measures/MConvertBase.h>
#include <casacore/measures/Measures/MFrequency.h>
 
namespace casacore {  // # NAMESPACE CASACORE - BEGIN
 
// # Forward Declarations
class MCFrequency;
class MDoppler;
class MVPosition;
class MVDirection;
class Aberration;
class String;
 
// # Typedefs
 
// <summary> MFrequency conversion routines </summary>
 
// <use visibility=local>
 
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tMeasure" demos="">
// </reviewed>
 
// <prerequisite>
//   <li> <linkto class=Measure>Measure</linkto> class
//   <li> <linkto class=MCBase>MCBase</linkto> base class
//   <li> <linkto class=MConvertBase>overall conversion</linkto>  class
// </prerequisite>
//
// <etymology>
// Measure, Convert and Frequency
// </etymology>
//
// <synopsis>
// Contains state machinery and caching for actual conversions
// </synopsis>
//
// <example>
// Get the Doppler shift for an oberved HI frequency of 1380 MHz
// <srcblock>
//  #include <casacore/measures/Measures.h>
//  #include <casacore/measures/Measures/MDoppler.h>
//  #include <casacore/measures/Measures/MFrequency.h>
//  cout << "Redshift for 1380 MHz: " <<
//      MDoppler::Convert( MFrequency( Quantity(1380., "MHz"),
//                         MFrequency::TOPO).toDoppler(QC::HI),
//                 MDoppler::Z)() << endl;
// </srcblock>
// </example>
//
// <motivation>
// </motivation>
//
// <todo asof="2003/03/03">
// </todo>
 
class MCFrequency : public MCBase {
 public:
  // # Friends
  //  Conversion of data
  friend class MeasConvert<MFrequency>;
 
  // # Constructors
  //  Default constructor
  MCFrequency();
 
  // # Destructor
  ~MCFrequency();
 
  // # Member functions
  //  Show the state of the conversion engine (mainly for debugging purposes)
  static String showState();
 
 private:
  // # Enumerations
  //  The list of actual routines provided.
  //  <note role=warning> Each <src>AA_BB</src> in the list points to routine
  //  that can be used in the FromTo list in the getConvert routine.
  //  In addition the type to which each is converted should be in the
  //  ToRef array, again in the proper order. </note>
  enum Routes {
    LSRD_BARY,
    BARY_LSRD,
    BARY_GEO,
    GEO_TOPO,
    GEO_BARY,
    TOPO_GEO,
    LSRD_GALACTO,
    GALACTO_LSRD,
    LSRK_BARY,
    BARY_LSRK,
    BARY_LGROUP,
    LGROUP_BARY,
    BARY_CMB,
    CMB_BARY,
    REST_LSRK,
    LSRK_REST,
    N_Routes
  };
 
  // # Typedefs
 
  // # Operators
 
  // # General Member Functions
 
  // # Enumerations
 
  // # Cached Data
  MVPosition *MVPOS1;
  MVDirection *MVDIR1;
  Aberration *ABERFROM;
  Aberration *ABERTO;
 
  // # State machine data
  //  Transition list
  static uInt ToRef_p[N_Routes][3];
  // Transition matrix
  static uInt FromTo_p[MFrequency::N_Types][MFrequency::N_Types];
  // Object to ensure safe multi-threaded lazy single initialization
  static std::once_flag theirInitOnceFlag;
 
  // # Constructors
  //  Copy constructor (not implemented)
  MCFrequency(const MCFrequency &other);
  // Assignment (not implemented)
  MCFrequency &operator=(const MCFrequency &other);
 
  // # Member functions
  //  Create conversion function pointer
  virtual void getConvert(MConvertBase &mc, const MRBase &inref, const MRBase &outref);
 
  // Create help structures for Measure conversion routines
  virtual void initConvert(uInt which, MConvertBase &mc);
 
  // Delete the pointers used in the MeasConvert help structure cache
  virtual void clearConvert();
 
  // Routine to convert frequency from one reference frame to another
  virtual void doConvert(MeasValue &in, MRBase &inref, MRBase &outref, const MConvertBase &mc);
  // Conversion routine to cater for inheritance question
  void doConvert(MVFrequency &in, MRBase &inref, MRBase &outref, const MConvertBase &mc);
 
 private:
  // Fill the global state. Called using theirInitOnce.
  static void doFillState();
};
 
}  // namespace casacore
 
#endif