casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
casacore::Muvw Class Reference

A Measure: uvw on Earth. More...

#include <Muvw.h>

Inheritance diagram for casacore::Muvw:
casacore::MeasBase< MVuvw, MeasRef< Muvw > > casacore::Measure

Public Types

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,
  DEFAULT,
  AZELNE,
  AZELNEGEO
}
 Types of known Muvws
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();
More...
 
typedef MVuvw MVType
 Measure value container for this class (i.e. More...
 
typedef MCuvw MCType
 Measure conversion routines for this class (i.e. More...
 
typedef MeasRef< MuvwRef
 Measure reference (i.e. More...
 
typedef MeasConvert< MuvwConvert
 MeasConvert use (i.e. More...
 
typedef ScalarMeasColumn< MuvwScalarColumn
 Measure table Columns (e.g., Muvw::ScalarColumn) More...
 
typedef ArrayMeasColumn< MuvwArrayColumn
 
- Public Types inherited from casacore::Measure
enum  Types {
  N_Types,
  DEFAULT
}
 Each derived class should have a Types enumeration, specifying the recognised frame types. More...
 
typedef void * Convert
 Each Measure should have typedefs of the form: More...
 

Public Member Functions

 Muvw ()
 
Tip: In the following constructors and other functions, all MeasRef can be replaced with simple Measure::TYPE where no offsets or frames are needed in the reference;
Default constructor; generates the ITRF centre More...
 
 Muvw (const MVuvw &dt)
 Create from data and reference. More...
 
 Muvw (const MVuvw &dt, const Muvw::Ref &rf)
 
 Muvw (const MVuvw &dt, Muvw::Types rf)
 
 Muvw (const Measure *dt)
 
 Muvw (const MeasValue *dt)
 
 Muvw (const Muvw &)
 Copy constructor and assign. More...
 
Muvwoperator= (const Muvw &)
 
virtual ~Muvw ()
 
virtual const StringtellMe () const
 Tell me your type. More...
 
virtual uInt type () const
 Get the type (== Register() of derived Measure (faster than Strings) All should have: static uInt myType();. More...
 
Bool giveMe (Muvw::Ref &mr, const String &in)
 
virtual Bool setOffset (const Measure &in)
 Set the offset in the reference (False if non-matching Measure) More...
 
virtual Bool setRefString (const String &in)
 Set the reference type to the specified String. More...
 
virtual const StringgetDefaultType () const
 Get the default reference type. More...
 
virtual const StringallTypes (Int &nall, Int &nextra, const uInt *&typ) const
 Get a list of all known reference codes. More...
 
virtual void checkTypes () const
 Check if all internal tables of types (both enum and String) are complete and correct. More...
 
virtual String getRefString () const
 Get the reference type (for records, including codes like R_) More...
 
Quantum< Vector< Double > > get (const Unit &inunit) const
 Get Measure data. More...
 
Quantum< Vector< Double > > getAngle () const
 
Quantum< Vector< Double > > getAngle (const Unit &inunit) const
 
virtual Measureclone () const
 Make copy. More...
 
- Public Member Functions inherited from casacore::MeasBase< MVuvw, MeasRef< Muvw > >
 MeasBase ()
 
Tip: In the following constructors and other functions, all MeasRef can be replaced with simple Measure::TYPE where no offsets or frames are needed in the reference; For reasons of compiler limitations the formal arguments had to be specified as uInt rather than the Measure enums that should be used as actual arguments;
Default constructor More...
 
 MeasBase (const MeasBase< MVuvw, MeasRef< Muvw > > &other)
 Copy constructor. More...
 
 MeasBase (const MVuvw &dt, const MeasRef< Muvw > &rf)
 Create from data and reference. More...
 
 MeasBase (const MVuvw &dt, uInt rf)
 
 MeasBase (const Quantity &dt, const MeasRef< Muvw > &rf)
 
 MeasBase (const Quantity &dt, uInt rf)
 
 MeasBase (const Measure *dt)
 
 MeasBase (const MeasRef< Muvw > &rf)
 
 MeasBase (const uInt rf)
 
MeasBase< MVuvw, MeasRef< Muvw > > & operator= (const MeasBase< MVuvw, MeasRef< Muvw > > &other)
 Copy assignment. More...
 
virtual ~MeasBase ()
 
virtual Bool areYou (const String &tp) const
 Check the type of derived entity. More...
 
virtual void assured (const String &tp) const
 Assert that we are the correct type. More...
 
void set (const MVuvw &dt)
 Refill the specified entities. More...
 
void set (const MeasRef< Muvw > &rf)
 
void set (const MVuvw &dt, const MeasRef< Muvw > &rf)
 
void set (const Unit &inunit)
 
virtual void set (const MeasValue &dt)
 Each Measure should have the following set functions (with appropiate MVs and Ref): More...
 
virtual Bool putValue (const Vector< Quantum< Double > > &in)
 
MeasRef< MuvwgetRef () const
 Get reference. More...
 
const MVuvwgetValue () const
 Get Measure data. More...
 
const UnitgetUnit () const
 Get Unit. More...
 
virtual MRBasegetRefPtr () const
 Get reference pointer. More...
 
virtual const MeasValuegetData () const
 Get pointer to data. More...
 
virtual void print (std::ostream &os) const
 Print a Measure. More...
 
- Public Member Functions inherited from casacore::Measure
virtual ~Measure ()
 Destructor. More...
 
virtual Bool isModel () const
 Tell me if you are a pure model (e.g. More...
 
void dummy_giveMe () const
 Each derived class should have a string-to-code translation routine for the reference type. More...
 
void dummy_getRef () const
 Each class should have a function to return its reference: More...
 
void dummy_getValue () const
 Each derived class should be able to get its internal value and have: More...
 

Static Public Member Functions

static const StringshowMe ()
 
static void assure (const Measure &in)
 
static Muvw::Types castType (uInt tp)
 Translate reference code. More...
 
static const StringshowType (Muvw::Types tp)
 
static const StringshowType (uInt tp)
 
static Bool getType (Muvw::Types &tp, const String &in)
 Translate string to reference code. More...
 
static const StringallMyTypes (Int &nall, Int &nextra, const uInt *&typ)
 
static void checkMyTypes ()
 
static Muvw::Types fromDirType (const MDirection::Types in)
 Get the correct Muvw type from a given direction type (or v.v.) More...
 
static MDirection::Types toDirType (const Muvw::Types in)
 
static uInt myType ()
 Get my type (as Register) More...
 
- Static Public Member Functions inherited from casacore::Measure
static uInt giveMe (const String &in, Int N_name, const String tname[])
 A general string checking routine to be used in derived measures. More...
 

Friends

class MeasConvert< Muvw >
 Conversion of data. More...
 

Additional Inherited Members

- Protected Attributes inherited from casacore::MeasBase< MVuvw, MeasRef< Muvw > >
MVuvw data
 The measure value (e.g. More...
 
MeasRef< Muvwref
 Reference frame data. More...
 
Unit unit
 Possible input units. More...
 

Detailed Description

A Measure: uvw on Earth.

Intended use:

Public interface

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25
Test programs:
tMuvw

Prerequisite

Etymology

From Measure and uvw

Synopsis

Muvw is the derived Measure class for an interferometer uvw. uvws can be given in any of the direction types, or as ITRF, the IERS base.
Note that at the moment no correction for Earth tides (error <~ 0.05 mm/km EW uvw), plate motion (not relevant for telescopes on same plate) and relativistic effects are incorporated. B1950 has the same caveat as in MDirection.

Example

// Specify an Epoch and a telescope position
MEpoch tbm(Quantity(50927.92931, "d"));
MPosition pos(MVPosition(-4750915.84032, 2792906.17778,
-3200483.75028),
// Use them in a frame
MeasFrame mf(tbm, pos);
// Specify an uvw (note that values here are in m)
MVuvw mvb0(100,10, 0);
cout << "uvw: " << mvb0 << endl;
// Specify a reference (type and where and when) for the following uvw
Muvw::Ref mbref0(Muvw::ITRF, mf);
Muvw mb0(mvb0, mbref0);
// Show the uvw
cout << "uvw: " << mb0 << endl;
cout << "uvw reference: " << mbref0 << endl;
// Another reference
cout << "uvw reference: " << mbref1 << endl;
// Convert the uvw coordinates to the other reference and show it
cout << "Test uvw conversion..." << endl;
Muvw::Convert bconv(mb0, mbref1);
cout << "Converted " << mb0 << endl <<
" to " << mbref1 << endl <<
" as " << bconv() << endl;

Motivation

To be able to handle conversions between uvw coordinates with different reference directions.

To Do

Definition at line 115 of file Muvw.h.

Member Typedef Documentation

Definition at line 171 of file Muvw.h.

MeasConvert use (i.e.

Muvw::Convert)

Definition at line 168 of file Muvw.h.

Measure conversion routines for this class (i.e.

Muvw::MCType)

Definition at line 164 of file Muvw.h.

Measure value container for this class (i.e.

Muvw::MVType)

Definition at line 162 of file Muvw.h.

Measure reference (i.e.

Muvw::Ref)

Definition at line 166 of file Muvw.h.

Measure table Columns (e.g., Muvw::ScalarColumn)

Definition at line 170 of file Muvw.h.

Member Enumeration Documentation

Types of known Muvws
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();

Enumerator
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 
DEFAULT 

Defaults.

AZELNE 

Synonyms.

AZELNEGEO 

Definition at line 130 of file Muvw.h.

Constructor & Destructor Documentation

casacore::Muvw::Muvw ( )


Tip: In the following constructors and other functions, all MeasRef can be replaced with simple Measure::TYPE where no offsets or frames are needed in the reference;
Default constructor; generates the ITRF centre

casacore::Muvw::Muvw ( const MVuvw dt)

Create from data and reference.

casacore::Muvw::Muvw ( const MVuvw dt,
const Muvw::Ref rf 
)
casacore::Muvw::Muvw ( const MVuvw dt,
Muvw::Types  rf 
)
casacore::Muvw::Muvw ( const Measure dt)
casacore::Muvw::Muvw ( const MeasValue dt)
casacore::Muvw::Muvw ( const Muvw )

Copy constructor and assign.

virtual casacore::Muvw::~Muvw ( )
virtual

Member Function Documentation

static const String* casacore::Muvw::allMyTypes ( Int nall,
Int nextra,
const uInt *&  typ 
)
static
virtual const String* casacore::Muvw::allTypes ( Int nall,
Int nextra,
const uInt *&  typ 
) const
virtual

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.

Reimplemented from casacore::Measure.

static void casacore::Muvw::assure ( const Measure in)
static
static Muvw::Types casacore::Muvw::castType ( uInt  tp)
static

Translate reference code.

The uInt version has a check for valid codes (i.e. it is a safe cast).

Thrown Exceptions

  • AipsError in the uInt interface if illegal code given
static void casacore::Muvw::checkMyTypes ( )
static
virtual void casacore::Muvw::checkTypes ( ) const
virtual

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 Exceptions

  • AipsError if a (programming) error in the types.

Implements casacore::Measure.

virtual Measure* casacore::Muvw::clone ( ) const
virtual

Make copy.

Implements casacore::Measure.

static Muvw::Types casacore::Muvw::fromDirType ( const MDirection::Types  in)
static

Get the correct Muvw type from a given direction type (or v.v.)

Quantum<Vector<Double> > casacore::Muvw::get ( const Unit inunit) const

Get Measure data.

Quantum<Vector<Double> > casacore::Muvw::getAngle ( ) const
Quantum<Vector<Double> > casacore::Muvw::getAngle ( const Unit inunit) const
virtual const String& casacore::Muvw::getDefaultType ( ) const
virtual

Get the default reference type.

Implements casacore::Measure.

virtual String casacore::Muvw::getRefString ( ) const
virtual

Get the reference type (for records, including codes like R_)

Implements casacore::Measure.

static Bool casacore::Muvw::getType ( Muvw::Types tp,
const String in 
)
static

Translate string to reference code.

Bool casacore::Muvw::giveMe ( Muvw::Ref mr,
const String in 
)
static uInt casacore::Muvw::myType ( )
static

Get my type (as Register)

Muvw& casacore::Muvw::operator= ( const Muvw )
virtual Bool casacore::Muvw::setOffset ( const Measure in)
virtual

Set the offset in the reference (False if non-matching Measure)

Implements casacore::Measure.

virtual Bool casacore::Muvw::setRefString ( const String in)
virtual

Set the reference type to the specified String.

False if illegal string, reference set to DEFAULT.

Implements casacore::Measure.

static const String& casacore::Muvw::showMe ( )
static
static const String& casacore::Muvw::showType ( Muvw::Types  tp)
static
static const String& casacore::Muvw::showType ( uInt  tp)
static
virtual const String& casacore::Muvw::tellMe ( ) const
virtual

Tell me your type.

Implements casacore::Measure.

static MDirection::Types casacore::Muvw::toDirType ( const Muvw::Types  in)
static
virtual uInt casacore::Muvw::type ( ) const
virtual

Get the type (== Register() of derived Measure (faster than Strings) All should have: static uInt myType();.

Implements casacore::Measure.

Friends And Related Function Documentation

friend class MeasConvert< Muvw >
friend

Conversion of data.

Definition at line 120 of file Muvw.h.


The documentation for this class was generated from the following file: