casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Static Public Member Functions | Friends
casa::MEarthMagnetic Class Reference

A Measure: Magnetic field on Earth. More...

#include <MEarthMagnetic.h>

Inheritance diagram for casa::MEarthMagnetic:
casa::MeasBase< MVEarthMagnetic, MeasRef< MEarthMagnetic > > casa::Measure

List of all members.

Public Types

enum  Types {
  J2000,
  JMEAN,
  JTRUE,
  APP,
  B1950,
  BMEAN,
  BTRUE,
  GALACTIC,
  HADEC,
  AZEL,
  AZELSW,
  AZELGEO,
  AZELSWGEO,
  JNAT,
  ECLIPTIC,
  MECLIPTIC,
  TECLIPTIC,
  SUPERGAL,
  ITRF,
  TOPO,
  ICRS,
  N_Types,
  IGRF,
  N_Models,
  EXTRA,
  DEFAULT,
  AZELNE,
  AZELNEGEO
}
 Types of known MEarthMagnetics
Tip: The order defines the order in the translation matrix FromTo in the getConvert routine in MCEarthMagnetic; 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 MVEarthMagnetic MVType
 Measure value container for this class (i.e.
typedef MCEarthMagnetic MCType
 Measure conversion routines for this class (i.e.
typedef MeasRef< MEarthMagneticRef
 Measure reference (i.e.
typedef MeasConvert
< MEarthMagnetic
Convert
 Measure Convert (i.e.
typedef ScalarMeasColumn
< MEarthMagnetic
ScalarColumn
 Measure table Columns (e.g., MEarthMagnetic::ScalarColumn)
typedef ArrayMeasColumn
< MEarthMagnetic
ArrayColumn

Public Member Functions

typedef WHATEVER_SUN_TYPEDEF (MEarthMagnetic) Types Types
 Reference enum Types (included originally for gcc 2.95)
 MEarthMagnetic ()
 
Note: 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 default IGRF type
 MEarthMagnetic (const MVEarthMagnetic &dt)
 Create from data and reference.
 MEarthMagnetic (const MVEarthMagnetic &dt, const MEarthMagnetic::Ref &rf)
 MEarthMagnetic (const MVEarthMagnetic &dt, MEarthMagnetic::Types rf)
 MEarthMagnetic (const Measure *dt)
 MEarthMagnetic (const MeasValue *dt)
 MEarthMagnetic (const MEarthMagnetic::Ref &rf)
 MEarthMagnetic (const MEarthMagnetic &)
 
     

MEarthMagneticoperator= (const MEarthMagnetic &)
virtual ~MEarthMagnetic ()
 
    

virtual const StringtellMe () const
 Tell me your type.
virtual uInt type () const
 Get the type (== Register() of derived Measure (faster than Strings) All should have: static uInt myType();.
Bool giveMe (MEarthMagnetic::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 StringgetDefaultType () const
 Get the default reference type.
virtual const StringallTypes (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_)
virtual Bool isModel () const
 Tell me if you are a pure model (e.g.
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 Measureclone () const
 Make copy.

Static Public Member Functions

static const StringshowMe ()
static void assure (const Measure &in)
static MEarthMagnetic::Types castType (uInt tp)
 Translate reference code.
static const StringshowType (MEarthMagnetic::Types tp)
static const StringshowType (uInt tp)
static Bool getType (MEarthMagnetic::Types &tp, const String &in)
 Translate string to reference code.
static const StringallMyTypes (Int &nall, Int &nextra, const uInt *&typ)
static void checkMyTypes ()
static uInt myType ()
 Get my type (as Register)

Friends

class MeasConvert< MEarthMagnetic >
 Conversion of data.

Detailed Description

A Measure: Magnetic field on Earth.

Intended use:

Public interface

 <h3>Review Status</h3><dl><dt>Reviewed By:<dd>UNKNOWN<dt>Date Reviewed:<dd>before2004/08/25</dl> 

Prerequisite

Etymology

Earth and Magnetic field

Synopsis

MEarthMagnetic forms derived Measure class for Earth' magnetic flux density. The field can be specified as a model, or as a 3D vector (see MVEarthMagnetic ) with a specified reference frame code. If a model is specified, a possibly specified explicit field will be ignored, since the field will be calculated from the model if a conversion is asked for.
The class contains the following magnetic field models:

The reference frame type can be any of the types specified in the MDirection direction types (e.g. AZEL).
Warning: The IGRF needs a Table of coefficients (at 5-year interval)

Conversion between field models is not supported (but not relevant anyway with only one model supported). Conversion to an explicit direction is done by the standard MeasConvert class and rules (see example) using MEarthMagnetic::Convert, and the reference types (e.g. MEarthMagnetic::AZEL).

An EarthMagneticMachine has been provided to get e.g. the field in a certain direction at a certain height.

Example

    // Where on Earth
    MPosition pos(MVPosition(Quantity(20,'m'), Quantity(5,'deg'), 
                             Quantity(52,'deg')), MPosition::WGS84);
    // Time we want it
    MEpoch epo(MVEpoch(50000));
    // Put in frame
    MeasFrame frame(pos, epo);
    // Magnetic field model
    MEarthMagnetic mf;
    // Show field strength in Gauss in AzEl system
    cout <<
      MEarthMagnetic::Convert(mf, MEarthMagnetic::AZEL)().
                getValue().getLength("G") << endl;

Motivation

To have the Earth' magnetic field in the standard Measure environment.

To Do

Definition at line 118 of file MEarthMagnetic.h.


Member Typedef Documentation

Definition at line 179 of file MEarthMagnetic.h.

Measure Convert (i.e.

MEarthMagnetic::Convert)

Reimplemented from casa::Measure.

Definition at line 176 of file MEarthMagnetic.h.

Measure conversion routines for this class (i.e.

MEarthMagnetic::MCType)

Definition at line 172 of file MEarthMagnetic.h.

Measure value container for this class (i.e.

MEarthMagnetic::MVType)

Definition at line 170 of file MEarthMagnetic.h.

Measure reference (i.e.

MEarthMagnetic::Ref)

Definition at line 174 of file MEarthMagnetic.h.

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

Definition at line 178 of file MEarthMagnetic.h.


Member Enumeration Documentation

Types of known MEarthMagnetics
Tip: The order defines the order in the translation matrix FromTo in the getConvert routine in MCEarthMagnetic; 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 
BMEAN 
BTRUE 
GALACTIC 
HADEC 
AZEL 
AZELSW 
AZELGEO 
AZELSWGEO 
JNAT 
ECLIPTIC 
MECLIPTIC 
TECLIPTIC 
SUPERGAL 
ITRF 
TOPO 
ICRS 
N_Types 
IGRF 

Models.

First one should be IGRF

N_Models 
EXTRA 

All extra bits (for internal use only)

DEFAULT 

Defaults.

AZELNE 

Synonyms.

AZELNEGEO 

Reimplemented from casa::Measure.

Definition at line 133 of file MEarthMagnetic.h.


Constructor & Destructor Documentation


Note: 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 default IGRF type

Create from data and reference.

     

    


Member Function Documentation

static const String* casa::MEarthMagnetic::allMyTypes ( Int nall,
Int nextra,
const uInt *&  typ 
) [static]
virtual const String* casa::MEarthMagnetic::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 casa::Measure.

static void casa::MEarthMagnetic::assure ( const Measure in) [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 casa::MEarthMagnetic::checkMyTypes ( ) [static]
virtual void casa::MEarthMagnetic::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 casa::Measure.

virtual Measure* casa::MEarthMagnetic::clone ( ) const [virtual]

Make copy.

Implements casa::Measure.

Quantum<Vector<Double> > casa::MEarthMagnetic::get ( const Unit inunit) const

Get Measure data.

virtual const String& casa::MEarthMagnetic::getDefaultType ( ) const [virtual]

Get the default reference type.

Implements casa::Measure.

virtual String casa::MEarthMagnetic::getRefString ( ) const [virtual]

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

Implements casa::Measure.

static Bool casa::MEarthMagnetic::getType ( MEarthMagnetic::Types tp,
const String in 
) [static]

Translate string to reference code.

virtual Bool casa::MEarthMagnetic::isModel ( ) const [virtual]

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

a planet)

Reimplemented from casa::Measure.

static uInt casa::MEarthMagnetic::myType ( ) [static]

Get my type (as Register)

MEarthMagnetic& casa::MEarthMagnetic::operator= ( const MEarthMagnetic )
virtual Bool casa::MEarthMagnetic::setOffset ( const Measure in) [virtual]

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

Implements casa::Measure.

virtual Bool casa::MEarthMagnetic::setRefString ( const String in) [virtual]

Set the reference type to the specified String.

False if illegal string, reference set to DEFAULT.

Implements casa::Measure.

static const String& casa::MEarthMagnetic::showMe ( ) [static]
static const String& casa::MEarthMagnetic::showType ( uInt  tp) [static]
virtual const String& casa::MEarthMagnetic::tellMe ( ) const [virtual]

Tell me your type.

Implements casa::Measure.

virtual uInt casa::MEarthMagnetic::type ( ) const [virtual]

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

Implements casa::Measure.

Reference enum Types (included originally for gcc 2.95)


Friends And Related Function Documentation

friend class MeasConvert< MEarthMagnetic > [friend]

Conversion of data.

Definition at line 123 of file MEarthMagnetic.h.


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