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::MDirection Class Reference

A Measure: astronomical direction. More...

#include <MDirection.h>

Inheritance diagram for casacore::MDirection:
casacore::MeasBase< MVDirection, MeasRef< MDirection > > 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,
  MERCURY,
  VENUS,
  MARS,
  JUPITER,
  SATURN,
  URANUS,
  NEPTUNE,
  PLUTO,
  SUN,
  MOON,
  COMET,
  N_Planets,
  EXTRA,
  DEFAULT,
  AZELNE,
  AZELNEGEO
}
 Types of known MDirections
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...
 
enum  GlobalTypes {
  GRADEC,
  GHADEC,
  GAZEL,
  GLONGLAT,
  N_GTypes
}
 Global types. More...
 
typedef MVDirection MVType
 Measure value container for this class (i.e. More...
 
typedef MCDirection MCType
 Measure conversion routines for this class (i.e. More...
 
typedef MeasRef< MDirectionRef
 Measure reference (i.e. More...
 
typedef MeasConvert< MDirectionConvert
 Measure Convert (i.e. More...
 
typedef ScalarMeasColumn
< MDirection
ScalarColumn
 Measure table Columns (e.g., MDirection::ScalarColumn) More...
 
typedef ArrayMeasColumn
< MDirection
ArrayColumn
 
- 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

 MDirection ()
 
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 J2000 pole direction More...
 
 MDirection (const MVDirection &dt)
 Create from data and reference. More...
 
 MDirection (const MVDirection &dt, const MDirection::Ref &rf)
 
 MDirection (const MVDirection &dt, MDirection::Types rf)
 
 MDirection (const Quantity &dt, const Quantity &dt1)
 
 MDirection (const Quantity &dt, const Quantity &dt1, const MDirection::Ref &rf)
 
 MDirection (const Quantity &dt, const Quantity &dt1, MDirection::Types rf)
 
 MDirection (const Quantum< Vector< Double > > &dt)
 
 MDirection (const Quantum< Vector< Double > > &dt, const MDirection::Ref &rf)
 
 MDirection (const Quantum< Vector< Double > > &dt, MDirection::Types rf)
 
 MDirection (const Measure *dt)
 
 MDirection (const MeasValue *dt)
 
 MDirection (const MDirection::Ref &rf)
 
 MDirection (MDirection::Types rf)
 
virtual ~MDirection ()
 
virtual const StringtellMe () const
 Tell me your type ('Direction') More...
 
virtual uInt type () const
 Tell me your reference type (as Register()) N.B. More...
 
Bool giveMe (MDirection::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...
 
virtual Bool isModel () const
 Tell me if you are a pure model (e.g. More...
 
Quantum< Vector< Double > > getAngle () const
 Get Measure data. More...
 
Quantum< Vector< Double > > getAngle (const Unit &inunit) const
 
void shift (const Quantum< Double > &lng, const Quantum< Double > &lat, Bool trueAngle=False)
 Shift the direction in longitude (radians if Double) and/or latitude. More...
 
void shift (Double lng, Double lat, Bool trueAngle=False)
 
void shiftLongitude (const Quantity &lng, Bool trueAngle=False)
 
void shiftLongitude (Double lng, Bool trueAngle=False)
 
void shiftLatitude (const Quantum< Double > &lat, Bool trueAngle=False)
 
void shiftLatitude (Double lat, Bool trueAngle=False)
 
void shift (const MVDirection &shft, Bool trueAngle=False)
 
void shiftAngle (const Quantum< Double > &off, const Quantum< Double > &pa)
 Shift over an angle off in the direction pa. More...
 
void shiftAngle (Double off, Double pa)
 
virtual Measureclone () const
 Make a copy. More...
 
String toString () const
 Convert to a String in astronomer-friendly format based on reference frame. More...
 
- Public Member Functions inherited from casacore::MeasBase< MVDirection, MeasRef< MDirection > >
 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< MVDirection, MeasRef< MDirection > > &other)
 Copy constructor. More...
 
 MeasBase (const MVDirection &dt, const MeasRef< MDirection > &rf)
 Create from data and reference. More...
 
 MeasBase (const MVDirection &dt, uInt rf)
 
 MeasBase (const Quantity &dt, const MeasRef< MDirection > &rf)
 
 MeasBase (const Quantity &dt, uInt rf)
 
 MeasBase (const Measure *dt)
 
 MeasBase (const MeasRef< MDirection > &rf)
 
 MeasBase (const uInt rf)
 
MeasBase< MVDirection, MeasRef
< MDirection > > & 
operator= (const MeasBase< MVDirection, MeasRef< MDirection > > &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 MVDirection &dt)
 Refill the specified entities. More...
 
void set (const MeasRef< MDirection > &rf)
 
void set (const MVDirection &dt, const MeasRef< MDirection > &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< MDirectiongetRef () const
 Get reference. More...
 
const MVDirectiongetValue () 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...
 
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 MDirection makeMDirection (const String &sourceName)
 Make an MDirection object given the case-insensitive name of a moving source (ZENITH, SUN, etc.), or of a known standard source (CygA, etc.). More...
 
static const StringshowMe ()
 
static void assure (const Measure &in)
 Assert you are a direction. More...
 
static MDirection::GlobalTypes globalType (uInt tp)
 Tell me the global type (like GRADEC) for tp (tp like MDirection::J2000) More...
 
static MDirection::Types castType (uInt tp)
 Translate reference code tp. More...
 
static const StringshowType (MDirection::Types tp)
 
static const StringshowType (uInt tp)
 
static Bool getType (MDirection::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 uInt myType ()
 Get my type (as Register) N.B. 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< MDirection >
 Conversion of data. More...
 

Additional Inherited Members

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

Detailed Description

A Measure: astronomical direction.

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

Synopsis

MDirection forms a derived Measure class for a direction in space.
An MDirection can be generated from a MVDirection or a pair of Quantities specifying a longitudinal and a latitudinal angle.
The different reference types that can be used for a Direction are:

Conversion between the different types is done with the standard MeasConvert class (MDirection::Convert in this case).
For some conversion additional MeasFrame information is essential. The following list specifies which information is needed if the conversion goes to or from the different types:

The conversion between B1950 and J2000 may have an Epoch. If none given an epoch of 2000.0 is assumed for the conversion, unless an aipsrc variable measures.b1950.d_epoch is given.

Conversions are based on the IAU system of precession and nutation (with IERS corrections if available); and on series expansions of the DE200 planetary ephemeris (J system; for B sytem older expansions) for the aberration and the solar position.
The HADEC position has corrections for polar motion and the equation of equinoxes; the AZEL will include Earth tides and refraction at a later stage.
Note that conversion between B1950 and J2000 can only be approximate, and is based on FK4 to FK5 conversion. The best conversion is to convert first to an apparent position at the time of observation, and convert from there to the other standard (the correct route will be followed).
Another problem can arise if the source has proper motion and/or radial velocities. These should be taken into account. An MCatalog class will maybe take care of that.
Warning: The offset that can be specified in the MDirection::Ref is an MDirection offset, and can not be used for specifying angular offsets; shift() methods are available for these cases;

To aid in formatting of the angles without having to check all difference referencetypes, the following global types are provided:

they can be obtained with the globalType() method.

Example

See Measures module description for extensive examples.

Motivation

To Do

Definition at line 174 of file MDirection.h.

Member Typedef Documentation

Definition at line 252 of file MDirection.h.

Measure Convert (i.e.

MDirection::Convert)

Definition at line 249 of file MDirection.h.

Measure conversion routines for this class (i.e.

MDirection::MCType)

Definition at line 245 of file MDirection.h.

Measure value container for this class (i.e.

MDirection::MVType)

Definition at line 243 of file MDirection.h.

Measure reference (i.e.

MDirection::Ref)

Definition at line 247 of file MDirection.h.

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

Definition at line 251 of file MDirection.h.

Member Enumeration Documentation

Global types.

Enumerator
GRADEC 
GHADEC 
GAZEL 
GLONGLAT 
N_GTypes 

Definition at line 234 of file MDirection.h.

Types of known MDirections
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 
MERCURY 

Planets.

First one should be Mercury

VENUS 
MARS 
JUPITER 
SATURN 
URANUS 
NEPTUNE 
PLUTO 
SUN 
MOON 
COMET 

Comet or other table-described solar system body.

N_Planets 
EXTRA 

All extra bits.

DEFAULT 

Defaults.

AZELNE 

Synonyms.

AZELNEGEO 

Definition at line 188 of file MDirection.h.

Constructor & Destructor Documentation

casacore::MDirection::MDirection ( )


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 J2000 pole direction

casacore::MDirection::MDirection ( const MVDirection dt)

Create from data and reference.

casacore::MDirection::MDirection ( const MVDirection dt,
const MDirection::Ref rf 
)
casacore::MDirection::MDirection ( const MVDirection dt,
MDirection::Types  rf 
)
casacore::MDirection::MDirection ( const Quantity dt,
const Quantity dt1 
)
casacore::MDirection::MDirection ( const Quantity dt,
const Quantity dt1,
const MDirection::Ref rf 
)
casacore::MDirection::MDirection ( const Quantity dt,
const Quantity dt1,
MDirection::Types  rf 
)
casacore::MDirection::MDirection ( const Quantum< Vector< Double > > &  dt)
casacore::MDirection::MDirection ( const Quantum< Vector< Double > > &  dt,
const MDirection::Ref rf 
)
casacore::MDirection::MDirection ( const Quantum< Vector< Double > > &  dt,
MDirection::Types  rf 
)
casacore::MDirection::MDirection ( const Measure dt)
casacore::MDirection::MDirection ( const MeasValue dt)
casacore::MDirection::MDirection ( const MDirection::Ref rf)
casacore::MDirection::MDirection ( MDirection::Types  rf)
virtual casacore::MDirection::~MDirection ( )
virtual

Member Function Documentation

static const String* casacore::MDirection::allMyTypes ( Int nall,
Int nextra,
const uInt *&  typ 
)
static
virtual const String* casacore::MDirection::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::MDirection::assure ( const Measure in)
static

Assert you are a direction.

static MDirection::Types casacore::MDirection::castType ( uInt  tp)
static

Translate reference code tp.

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::MDirection::checkMyTypes ( )
static
virtual void casacore::MDirection::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::MDirection::clone ( ) const
virtual

Make a copy.

Implements casacore::Measure.

Quantum<Vector<Double> > casacore::MDirection::getAngle ( ) const

Get Measure data.

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

Get the default reference type.

Implements casacore::Measure.

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

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

Implements casacore::Measure.

Referenced by casa::sdfiller::SourceRecord::add().

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

Translate string to reference code.

Bool casacore::MDirection::giveMe ( MDirection::Ref mr,
const String in 
)
static MDirection::GlobalTypes casacore::MDirection::globalType ( uInt  tp)
static

Tell me the global type (like GRADEC) for tp (tp like MDirection::J2000)

virtual Bool casacore::MDirection::isModel ( ) const
virtual

Tell me if you are a pure model (e.g.

a planet)

Reimplemented from casacore::Measure.

static MDirection casacore::MDirection::makeMDirection ( const String sourceName)
static

Make an MDirection object given the case-insensitive name of a moving source (ZENITH, SUN, etc.), or of a known standard source (CygA, etc.).

static uInt casacore::MDirection::myType ( )
static

Get my type (as Register) N.B.

Being static, it does NOT return the type of an instance, i.e. use it as MDirection::myType(), not md.myType().

virtual Bool casacore::MDirection::setOffset ( const Measure in)
virtual

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

Implements casacore::Measure.

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

Set the reference type to the specified String.

False if illegal string, reference set to DEFAULT.

Implements casacore::Measure.

void casacore::MDirection::shift ( const Quantum< Double > &  lng,
const Quantum< Double > &  lat,
Bool  trueAngle = False 
)

Shift the direction in longitude (radians if Double) and/or latitude.

If the trueAngle switch is True, the longitude shift will be in angular units perpendicular to the direction to pole, along a great circle. See MVDirection for more details.

void casacore::MDirection::shift ( Double  lng,
Double  lat,
Bool  trueAngle = False 
)
void casacore::MDirection::shift ( const MVDirection shft,
Bool  trueAngle = False 
)
void casacore::MDirection::shiftAngle ( const Quantum< Double > &  off,
const Quantum< Double > &  pa 
)

Shift over an angle off in the direction pa.

pa is measured from North, in the direction of increasing longitude. See MVDirection for implementation.

void casacore::MDirection::shiftAngle ( Double  off,
Double  pa 
)
void casacore::MDirection::shiftLatitude ( const Quantum< Double > &  lat,
Bool  trueAngle = False 
)
void casacore::MDirection::shiftLatitude ( Double  lat,
Bool  trueAngle = False 
)
void casacore::MDirection::shiftLongitude ( const Quantity lng,
Bool  trueAngle = False 
)
void casacore::MDirection::shiftLongitude ( Double  lng,
Bool  trueAngle = False 
)
static const String& casacore::MDirection::showMe ( )
static
static const String& casacore::MDirection::showType ( MDirection::Types  tp)
static
static const String& casacore::MDirection::showType ( uInt  tp)
static
virtual const String& casacore::MDirection::tellMe ( ) const
virtual

Tell me your type ('Direction')

Implements casacore::Measure.

String casacore::MDirection::toString ( ) const

Convert to a String in astronomer-friendly format based on reference frame.

virtual uInt casacore::MDirection::type ( ) const
virtual

Tell me your reference type (as Register()) N.B.

as defined in MDirection.cc, it does NOT return the type of an instance, i.e. it just returns Register(static_cast<MDirection *>(0)).

Implements casacore::Measure.

Friends And Related Function Documentation

friend class MeasConvert< MDirection >
friend

Conversion of data.

Definition at line 179 of file MDirection.h.


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