Loading...
Searching...
No Matches
casacore::MBaseline Class Reference
measures package (libcasa_measures) » Measures_module

More...

`#include <MBaseline.h>`

## 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 MBaselines 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 MVBaseline | MVType
| Measure value container for this class (i.e.
typedef MCBaseline | MCType
| Measure conversion routines for this class (i.e.
typedef MeasRef< MBaseline > | Ref
| Measure reference (i.e.
typedef MeasConvert< MBaseline > | Convert
| Measure Convert (i.e.
typedef ScalarMeasColumn< MBaseline > | ScalarColumn
| Measure table Columns (e.g., MBaseline::ScalarColumn).
typedef ArrayMeasColumn< MBaseline > | 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:

## Public Member Functions

| MBaseline ()
| 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
| MBaseline (const MVBaseline &dt)
| Create from data and reference.
| MBaseline (const MVBaseline &dt, const MBaseline::Ref &rf)
| MBaseline (const MVBaseline &dt, MBaseline::Types rf)
| MBaseline (const Measure *dt)
| MBaseline (const MeasValue *dt)
| MBaseline (const MBaseline &)
MBaseline & | operator= (const MBaseline &)
virtual | ~MBaseline ()
virtual const String & | tellMe () const
| Tell me your type.
Bool | giveMe (MBaseline::Ref &mr, const String &in)
virtual Bool | setOffset (const Measure &in)
| Set the offset in the reference (False if non-matching Measure).
virtual Bool | setRefString (const String &in)
| Set the reference type to the specified String.
virtual const String & | getDefaultType () const
| Get the default reference type.
virtual const String * | allTypes (Int &nall, Int &nextra, const uInt *&typ) const
| Get a list of all known reference codes.
virtual void | checkTypes () const
| Check if all internal tables of types (both enum and String) are complete and correct.
virtual String | getRefString () const
| Get the reference type (for records, including codes like R_).
Quantum< Vector< Double > > | get (const Unit &inunit) const
| Get Measure data.
Quantum< Vector< Double > > | getAngle () const
Quantum< Vector< Double > > | getAngle (const Unit &inunit) const
virtual Measure * | clone () const
| Make copy.
Public Member Functions inherited from casacore::MeasBase< MVBaseline, MeasRef< MBaseline > >
| 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
MeasBase< MVBaseline, MeasRef< MBaseline > > & | operator= (const MeasBase< MVBaseline, MeasRef< MBaseline > > &other)
| Copy assignment.
virtual | ~MeasBase ()
virtual Bool | areYou (const String &tp) const
| Check the type of derived entity.
virtual void | assured (const String &tp) const
| Assert that we are the correct type.
void | set (const MVBaseline &dt)
| Refill the specified entities.
virtual Bool | putValue (const Vector< Quantum< Double > > &in)
MeasRef< MBaseline > | getRef () const
| Get reference.
const MVBaseline & | getValue () const
| Get Measure data.
const Unit & | getUnit () const
| Get Unit.
virtual MRBase * | getRefPtr () const
| Get reference pointer.
virtual const MeasValue * | getData () const
| Get pointer to data.
virtual void | print (std::ostream &os) const
| Print a Measure.
Public Member Functions inherited from casacore::Measure
virtual | ~Measure ()
| Destructor.
virtual void | set (const MeasValue &dt)=0
| Each Measure should have the following set functions (with appropiate MVs and Ref):
virtual Bool | isModel () const
| Tell me if you are a pure model (e.g.
void | dummy_giveMe () const
| Each derived class should have a string-to-code translation routine for the reference type.
void | dummy_getRef () const
| Each class should have a function to return its reference:
void | dummy_getValue () const
| Each derived class should be able to get its internal value and have:

## Static Public Member Functions

static const String & | showMe ()
static void | assure (const Measure &in)
static MBaseline::Types | castType (uInt tp)
| Translate reference code.
static const String & | showType (MBaseline::Types tp)
static const String & | showType (uInt tp)
static Bool | getType (MBaseline::Types &tp, const String &in)
| Translate string to reference code.
static const String * | allMyTypes (Int &nall, Int &nextra, const uInt *&typ)
static void | checkMyTypes ()
static MBaseline::Types | fromDirType (const MDirection::Types in)
| Get the correct MBaseline type from a given direction type (or v.v.).
static MDirection::Types | toDirType (const MBaseline::Types in)
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.

## Friends

class | MeasConvert< MBaseline >
| Conversion of data.

## Additional Inherited Members

Protected Attributes inherited from casacore::MeasBase< MVBaseline, MeasRef< MBaseline > >
MVBaseline | data
| The measure value (e.g.
MeasRef< MBaseline > | ref
| Reference frame data.
Unit | unit
| Possible input units.

## Detailed Description

A Measure: Baseline on Earth

### Intended use:

Public interface

### Review Status

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

### Prerequisite

- Measure class

### Etymology

From Measure and Baseline

### 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.
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 MDirection.

### Example

### Motivation

### To Do

- add some Earth tide model

Definition at line 82 of file MBaseline.h.

## Member Typedef Documentation

## ArrayColumn

typedef ArrayMeasColumn<MBaseline> casacore::MBaseline::ArrayColumn

Definition at line 138 of file MBaseline.h.

## Convert

typedef MeasConvert<MBaseline> casacore::MBaseline::Convert

Measure Convert (i.e.

MBaseline::Convert)

Definition at line 135 of file MBaseline.h.

## MCType

typedef MCBaseline casacore::MBaseline::MCType

Measure conversion routines for this class (i.e.

MBaseline::MCType)

Definition at line 131 of file MBaseline.h.

## MVType

typedef MVBaseline casacore::MBaseline::MVType

Measure value container for this class (i.e.

MBaseline::MVType)

Definition at line 129 of file MBaseline.h.

## Ref

typedef MeasRef<MBaseline> casacore::MBaseline::Ref

Measure reference (i.e.

MBaseline::Ref)

Definition at line 133 of file MBaseline.h.

## ScalarColumn

typedef ScalarMeasColumn<MBaseline> casacore::MBaseline::ScalarColumn

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

Definition at line 137 of file MBaseline.h.

## Member Enumeration Documentation

## Types

enum casacore::MBaseline::Types

Types of known MBaselines
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 97 of file MBaseline.h.

## Constructor & Destructor Documentation

## MBaseline() [1/7]

casacore::MBaseline::MBaseline | ( |  | ) |

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

Referenced by MBaseline(), MeasConvert< MBaseline >, and operator=().

## MBaseline() [2/7]

casacore::MBaseline::MBaseline | ( | const MVBaseline & | dt | ) |

Create from data and reference.

## MBaseline() [3/7]

casacore::MBaseline::MBaseline | ( | const MVBaseline & | dt,
|  | const MBaseline::Ref & | rf )

## MBaseline() [4/7]

casacore::MBaseline::MBaseline | ( | const MVBaseline & | dt,
|  | MBaseline::Types | rf )

## MBaseline() [5/7]

casacore::MBaseline::MBaseline | ( | const Measure * | dt | ) |

## MBaseline() [6/7]

casacore::MBaseline::MBaseline | ( | const MeasValue * | dt | ) |

## MBaseline() [7/7]

casacore::MBaseline::MBaseline | ( | const MBaseline & |  | ) |

References MBaseline().

## ~MBaseline()

virtual casacore::MBaseline::~MBaseline | ( |  | ) |

virtual

## Member Function Documentation

## allMyTypes()

const String * casacore::MBaseline::allMyTypes | ( | Int & | nall,
|  | Int & | nextra,
|  | const uInt *& | typ )

static

## allTypes()

virtual const String * casacore::MBaseline::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.

## assure()

void casacore::MBaseline::assure | ( | const Measure & | in | ) |

static

## castType()

MBaseline::Types casacore::MBaseline::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

## checkMyTypes()

void casacore::MBaseline::checkMyTypes | ( |  | ) |

static

## checkTypes()

virtual void casacore::MBaseline::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.

## clone()

virtual Measure * casacore::MBaseline::clone | ( |  | ) | const

virtual

Make copy.

Implements casacore::Measure.

## fromDirType()

MBaseline::Types casacore::MBaseline::fromDirType | ( | const MDirection::Types | in | ) |

static

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

## get()

Quantum< Vector< Double > > casacore::MBaseline::get | ( | const Unit & | inunit | ) | const

Get Measure data.

## getAngle() [1/2]

Quantum< Vector< Double > > casacore::MBaseline::getAngle | ( |  | ) | const

## getAngle() [2/2]

Quantum< Vector< Double > > casacore::MBaseline::getAngle | ( | const Unit & | inunit | ) | const

## getDefaultType()

virtual const String & casacore::MBaseline::getDefaultType | ( |  | ) | const

virtual

Get the default reference type.

Implements casacore::Measure.

## getRefString()

virtual String casacore::MBaseline::getRefString | ( |  | ) | const

virtual

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

Implements casacore::Measure.

## getType()

Bool casacore::MBaseline::getType | ( | MBaseline::Types & | tp,
|  | const String & | in )

static

Translate string to reference code.

## giveMe()

Bool casacore::MBaseline::giveMe | ( | MBaseline::Ref & | mr,
|  | const String & | in )

## operator=()

MBaseline & casacore::MBaseline::operator= | ( | const MBaseline & |  | ) |

References MBaseline().

## setOffset()

virtual Bool casacore::MBaseline::setOffset | ( | const Measure & | in | ) |

virtual

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

Implements casacore::Measure.

## setRefString()

virtual Bool casacore::MBaseline::setRefString | ( | const String & | in | ) |

virtual

Set the reference type to the specified String.

False if illegal string, reference set to DEFAULT.

Implements casacore::Measure.

## showMe()

const String & casacore::MBaseline::showMe | ( |  | ) |

static

## showType() [1/2]

const String & casacore::MBaseline::showType | ( | MBaseline::Types | tp | ) |

static

## showType() [2/2]

const String & casacore::MBaseline::showType | ( | uInt | tp | ) |

static

## tellMe()

virtual const String & casacore::MBaseline::tellMe | ( |  | ) | const

virtual

Tell me your type.

Implements casacore::Measure.

## toDirType()

MDirection::Types casacore::MBaseline::toDirType | ( | const MBaseline::Types | in | ) |

static

## Friends And Related Symbol Documentation

## MeasConvert< MBaseline >

friend class MeasConvert< MBaseline >

friend

Conversion of data.

Definition at line 1 of file MBaseline.h.

References MBaseline().

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

- measures/Measures/MBaseline.h