Loading...
Searching...
No Matches
MBaseline.h
Go to the documentation of this file.
//# MBaseline.h: A Measure: Baseline on Earth
//# Copyright (C) 1998-2000,2002,2004,2007
//# 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_MBASELINE_H
#define MEASURES_MBASELINE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/measures/Measures/MeasBase.h>
#include <casacore/measures/Measures/MDirection.h>
#include <casacore/measures/Measures/MeasRef.h>
#include <casacore/casa/Quanta/MVBaseline.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class MBaseline;
class MCBaseline;
template <class M> class MeasConvert;
template <class M> class ArrayMeasColumn;
template <class M> class ScalarMeasColumn;
//# Typedefs
// <summary> A Measure: Baseline on Earth </summary>
// <use visibility=export>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tMBaseline" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=Measure>Measure</linkto> class
// </prerequisite>
//
// <etymology>
// From Measure and Baseline
// </etymology>
//
// <synopsis>
// MBaseline forms derived Measure class for an interferometer baseline.
// Baselines can be given in any of the direction types, or as ITRF, the
// IERS base.<br>
// Note that at the moment no correction for Earth tides (error <~ 0.05 mm/km
// EW baseline), plate motion (not relevant for telescopes on same plate) and
// relativistic effects are incorporated. B1950 has the same caveat as in
// <linkto class=MDirection>MDirection</linkto>.
// </synopsis>
//
// <example>
// </example>
//
// <motivation>
// </motivation>
//
// <todo asof="2000/06/15">
// <li> add some Earth tide model
// </todo>
class MBaseline : public MeasBase<MVBaseline, MeasRef<MBaseline> > {
public:
//# Friends
// Conversion of data
friend class MeasConvert<MBaseline>;
//# Enumerations
// Types of known MBaselines
// <note role=warning>
// The order defines the order in the translation matrix FromTo
// in the getConvert routine. Do not change the order without
// changing the array. Additions should be made before N_types, and
// an additional row and column should be coded in FromTo, and
// in showType().</note>
enum Types {
J2000,
JMEAN,
JTRUE,
APP,
B1950,
B1950_VLA,
BMEAN,
BTRUE,
GALACTIC,
HADEC,
AZEL,
AZELSW,
AZELGEO,
AZELSWGEO,
JNAT,
ECLIPTIC,
MECLIPTIC,
TECLIPTIC,
SUPERGAL,
ITRF,
TOPO,
ICRS,
N_Types,
// Defaults
DEFAULT=ITRF,
// Synonyms
AZELNE=AZEL,
AZELNEGEO=AZELGEO };
//# Typedefs
// Measure value container for this class (i.e. MBaseline::MVType)
typedef MVBaseline MVType;
// Measure conversion routines for this class (i.e. MBaseline::MCType)
typedef MCBaseline MCType;
// Measure reference (i.e. MBaseline::Ref)
typedef MeasRef<MBaseline> Ref;
// Measure Convert (i.e. MBaseline::Convert)
typedef MeasConvert<MBaseline> Convert;
// Measure table Columns (e.g., MBaseline::ScalarColumn)
typedef ScalarMeasColumn<MBaseline> ScalarColumn;
typedef ArrayMeasColumn<MBaseline> ArrayColumn;
//# 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>
// Default constructor; generates the ITRF centre
MBaseline();
// Create from data and reference
// <group>
MBaseline(const MVBaseline &dt);
MBaseline(const MVBaseline &dt, const MBaseline::Ref &rf);
MBaseline(const MVBaseline &dt, MBaseline::Types rf);
MBaseline(const Measure *dt);
MBaseline(const MeasValue *dt);
// </group>
// <group>
MBaseline(const MBaseline &);
MBaseline &operator=(const MBaseline &);
// </group>
//# Destructor
virtual ~MBaseline();
//# Operators
//# General Member Functions
// Tell me your type
// <group>
virtual const String &tellMe() const;
static const String &showMe();
static void assure(const Measure &in);
// </group>
// Translate reference code. The uInt version has a check for valid codes
// (i.e. it is a safe cast).
// <thrown>
// <li> AipsError in the uInt interface if illegal code given
// </thrown>
// <group>
static MBaseline::Types castType(uInt tp);
static const String &showType(MBaseline::Types tp);
static const String &showType(uInt tp);
// </group>
// Translate string to reference code
// <group>
static Bool getType(MBaseline::Types &tp, const String &in);
Bool giveMe(MBaseline::Ref &mr, const String &in);
// </group>
// Set the offset in the reference (False if non-matching Measure)
virtual Bool setOffset(const Measure &in);
// Set the reference type to the specified String. False if illegal
// string, reference set to DEFAULT.
virtual Bool setRefString(const String &in);
// Get the default reference type
virtual const String &getDefaultType() const;
// Get a list of all known reference codes. nall returns the number in list,
// nextra the number of specials (like planets) that should be at
// end of list). typ returns the list of corresponding types.
// <group>
virtual const String* allTypes(Int &nall, Int &nextra,
const uInt *&typ) const;
static const String* allMyTypes(Int &nall, Int &nextra,
const uInt *&typ);
// </group>
// Check if all internal tables of types (both enum and String) are
// complete and correct. This function is called automatically if and when
// necessary.
// <thrown>
// <li> AipsError if a (programming) error in the types.
// </thrown>
// <group>
virtual void checkTypes() const;
static void checkMyTypes();
// </group>
// Get the correct MBaseline type from a given direction type (or v.v.)
// <group>
static MBaseline::Types fromDirType(const MDirection::Types in);
static MDirection::Types toDirType(const MBaseline::Types in);
// </group>
// Get the reference type (for records, including codes like R_)
virtual String getRefString() const;
// Get Measure data
// <group>
Quantum<Vector<Double> > get(const Unit &inunit) const;
Quantum<Vector<Double> > getAngle() const;
Quantum<Vector<Double> > getAngle(const Unit &inunit) const;
// </group>
// Make copy
// <group>
virtual Measure *clone() const;
// </group>
private:
//# Enumerations
//# Data
//# Member functions
};
} //# NAMESPACE CASACORE - END
#endif
casacore::ArrayMeasColumn
Definition ArrayMeasColumn.h:169
casacore::MBaseline::getType
static Bool getType(MBaseline::Types &tp, const String &in)
Translate string to reference code.
casacore::MBaseline::showType
static const String & showType(MBaseline::Types tp)
casacore::MBaseline::MBaseline
MBaseline(const MVBaseline &dt, const MBaseline::Ref &rf)
casacore::MBaseline::fromDirType
static MBaseline::Types fromDirType(const MDirection::Types in)
Get the correct MBaseline type from a given direction type (or v.v.).
casacore::MBaseline::showType
static const String & showType(uInt tp)
casacore::MBaseline::get
Quantum< Vector< Double > > get(const Unit &inunit) const
Get Measure data.
casacore::MBaseline::checkMyTypes
static void checkMyTypes()
casacore::MBaseline::checkTypes
virtual void checkTypes() const
Check if all internal tables of types (both enum and String) are complete and correct.
casacore::MBaseline::toDirType
static MDirection::Types toDirType(const MBaseline::Types in)
casacore::MBaseline::Types
Types
Types of known MBaselines Warning: The order defines the order in the translation matrix FromTo in t...
Definition MBaseline.h:97
casacore::MBaseline::JTRUE
@ JTRUE
Definition MBaseline.h:100
casacore::MBaseline::GALACTIC
@ GALACTIC
Definition MBaseline.h:106
casacore::MBaseline::B1950
@ B1950
Definition MBaseline.h:102
casacore::MBaseline::BMEAN
@ BMEAN
Definition MBaseline.h:104
casacore::MBaseline::ICRS
@ ICRS
Definition MBaseline.h:119
casacore::MBaseline::ECLIPTIC
@ ECLIPTIC
Definition MBaseline.h:113
casacore::MBaseline::ITRF
@ ITRF
Definition MBaseline.h:117
casacore::MBaseline::APP
@ APP
Definition MBaseline.h:101
casacore::MBaseline::DEFAULT
@ DEFAULT
Defaults.
Definition MBaseline.h:122
casacore::MBaseline::AZELSW
@ AZELSW
Definition MBaseline.h:109
casacore::MBaseline::JMEAN
@ JMEAN
Definition MBaseline.h:99
casacore::MBaseline::TECLIPTIC
@ TECLIPTIC
Definition MBaseline.h:115
casacore::MBaseline::AZEL
@ AZEL
Definition MBaseline.h:108
casacore::MBaseline::MECLIPTIC
@ MECLIPTIC
Definition MBaseline.h:114
casacore::MBaseline::N_Types
@ N_Types
Definition MBaseline.h:120
casacore::MBaseline::AZELNE
@ AZELNE
Synonyms.
Definition MBaseline.h:124
casacore::MBaseline::AZELSWGEO
@ AZELSWGEO
Definition MBaseline.h:111
casacore::MBaseline::JNAT
@ JNAT
Definition MBaseline.h:112
casacore::MBaseline::TOPO
@ TOPO
Definition MBaseline.h:118
casacore::MBaseline::AZELGEO
@ AZELGEO
Definition MBaseline.h:110
casacore::MBaseline::SUPERGAL
@ SUPERGAL
Definition MBaseline.h:116
casacore::MBaseline::B1950_VLA
@ B1950_VLA
Definition MBaseline.h:103
casacore::MBaseline::AZELNEGEO
@ AZELNEGEO
Definition MBaseline.h:125
casacore::MBaseline::HADEC
@ HADEC
Definition MBaseline.h:107
casacore::MBaseline::J2000
@ J2000
Definition MBaseline.h:98
casacore::MBaseline::BTRUE
@ BTRUE
Definition MBaseline.h:105
casacore::MBaseline::giveMe
Bool giveMe(MBaseline::Ref &mr, const String &in)
casacore::MBaseline::getAngle
Quantum< Vector< Double > > getAngle() const
casacore::MBaseline::clone
virtual Measure * clone() const
Make copy.
casacore::MBaseline::ArrayColumn
ArrayMeasColumn< MBaseline > ArrayColumn
Definition MBaseline.h:138
casacore::MBaseline::MBaseline
MBaseline(const MeasValue *dt)
casacore::MBaseline::setRefString
virtual Bool setRefString(const String &in)
Set the reference type to the specified String.
casacore::MBaseline::MBaseline
MBaseline(const MBaseline &)
casacore::MBaseline::getDefaultType
virtual const String & getDefaultType() const
Get the default reference type.
casacore::MBaseline::operator=
MBaseline & operator=(const MBaseline &)
casacore::MBaseline::tellMe
virtual const String & tellMe() const
Tell me your type.
casacore::MBaseline::MBaseline
MBaseline(const Measure *dt)
casacore::MBaseline::getRefString
virtual String getRefString() const
Get the reference type (for records, including codes like R_).
casacore::MBaseline::allTypes
virtual const String * allTypes(Int &nall, Int &nextra, const uInt *&typ) const
Get a list of all known reference codes.
casacore::MBaseline::~MBaseline
virtual ~MBaseline()
casacore::MBaseline::castType
static MBaseline::Types castType(uInt tp)
Translate reference code.
casacore::MBaseline::MVType
MVBaseline MVType
Measure value container for this class (i.e.
Definition MBaseline.h:129
casacore::MBaseline::allMyTypes
static const String * allMyTypes(Int &nall, Int &nextra, const uInt *&typ)
casacore::MBaseline::MBaseline
MBaseline(const MVBaseline &dt)
Create from data and reference.
casacore::MBaseline::MCType
MCBaseline MCType
Measure conversion routines for this class (i.e.
Definition MBaseline.h:131
casacore::MBaseline::getAngle
Quantum< Vector< Double > > getAngle(const Unit &inunit) const
casacore::MBaseline::setOffset
virtual Bool setOffset(const Measure &in)
Set the offset in the reference (False if non-matching Measure).
casacore::MBaseline::MBaseline
MBaseline()
Tip: In the following constructors and other functions, all MeasRef can be replaced with simple Measu...
casacore::MBaseline::ScalarColumn
ScalarMeasColumn< MBaseline > ScalarColumn
Measure table Columns (e.g., MBaseline::ScalarColumn).
Definition MBaseline.h:137
casacore::MBaseline::Convert
MeasConvert< MBaseline > Convert
Measure Convert (i.e.
Definition MBaseline.h:135
casacore::MBaseline::assure
static void assure(const Measure &in)
casacore::MBaseline::showMe
static const String & showMe()
casacore::MBaseline::MBaseline
MBaseline(const MVBaseline &dt, MBaseline::Types rf)
casacore::MBaseline::Ref
MeasRef< MBaseline > Ref
Measure reference (i.e.
Definition MBaseline.h:133
casacore::MCBaseline
Definition MCBaseline.h:82
casacore::MDirection::Types
Types
Types of known MDirections Warning: The order defines the order in the translation matrix FromTo in ...
Definition MDirection.h:185
casacore::MVBaseline
Definition MVBaseline.h:106
casacore::MeasBase< MVBaseline, MeasRef< MBaseline > >::MeasBase
MeasBase()
casacore::MeasConvert
Definition MeasConvert.h:143
casacore::MeasRef
Definition MeasRef.h:80
casacore::MeasValue
Definition MeasValue.h:104
casacore::Measure
Definition Measure.h:232
casacore::Quantum
Definition Quantum.h:269
casacore::ScalarMeasColumn
Definition ScalarMeasColumn.h:141
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::Unit
Definition Unit.h:187
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::Int
int Int
Definition aipstype.h:48
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40