MEarthMagnetic.h

Classes

MEarthMagnetic -- A Measure: Magnetic field on Earth (full description)

class MEarthMagnetic : public MeasBase<MVEarthMagnetic, MeasRef<MEarthMagnetic> >

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 = 32
Models. First one should be IGRF

N_Models

EXTRA = 32
All extra bits (for internal use only)

DEFAULT = IGRF,
Defaults

AZELNE = AZEL,AZELNEGEO=AZELGEO
Synonyms Synonyms

Interface

Public Members

typedef WHATEVER_SUN_TYPEDEF(MEarthMagnetic) Types Types

MEarthMagnetic()

MEarthMagnetic(const MVEarthMagnetic &dt)

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 &)

MEarthMagnetic &operator=(const MEarthMagnetic &)

virtual ~MEarthMagnetic()

virtual const String &tellMe() const

static const String &showMe()

virtual uInt type() const

static void assure(const Measure &in)

static MEarthMagnetic::Types castType(uInt tp)

static const String &showType(MEarthMagnetic::Types tp)

static const String &showType(uInt tp)

static Bool getType(MEarthMagnetic::Types &tp, const String &in)

Bool giveMe(MEarthMagnetic::Ref &mr, const String &in)

virtual Bool setOffset(const Measure &in)

virtual Bool setRefString(const String &in)

virtual const String &getDefaultType() const

virtual const String *const allTypes(Int &nall, Int &nextra, const uInt *&typ) const

static const String *const allMyTypes(Int &nall, Int &nextra, const uInt *&typ)

virtual void checkTypes() const

static void checkMyTypes()

virtual String getRefString() const

static uInt myType()

virtual Bool isModel() const

Quantum<Vector<Double> > get(const Unit &inunit) const

Quantum<Vector<Double> > getAngle() const

Quantum<Vector<Double> > getAngle(const Unit &inunit) const

virtual Measure *clone() const

Description

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25

Prerequisite

Measure class

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:

IGRF international reference field

The reference frame type can be any of the types specified in the MDirection direction types (e.g. AZEL).

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

maybe add other field models if necessary (e.g. dipole)

Member Description

enum Types

Types of known MEarthMagnetics

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().

typedef WHATEVER_SUN_TYPEDEF(MEarthMagnetic) Types Types

Reference enum Types (included originally for gcc 2.95)

MEarthMagnetic()

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)
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)

Create from data and reference

MEarthMagnetic(const MEarthMagnetic &)
MEarthMagnetic &operator=(const MEarthMagnetic &)

virtual ~MEarthMagnetic()

virtual const String &tellMe() const
static const String &showMe()
virtual uInt type() const
static void assure(const Measure &in)

Tell me your type

static MEarthMagnetic::Types castType(uInt tp)
static const String &showType(MEarthMagnetic::Types tp)
static const String &showType(uInt tp)

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 Bool getType(MEarthMagnetic::Types &tp, const String &in)
Bool giveMe(MEarthMagnetic::Ref &mr, const String &in)

Translate string to reference code

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. False if illegal string, reference set to DEFAULT.

virtual const String &getDefaultType() const

Get the default reference type

virtual const String const allTypes(Int &nall, Int &nextra, const uInt &typ) const
static const String const allMyTypes(Int &nall, Int &nextra, const uInt &typ)

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.

virtual void checkTypes() const
static void checkMyTypes()

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.

virtual String getRefString() const

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

static uInt myType()

Get my type (as Register)

virtual Bool isModel() const

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

Quantum<Vector<Double> > get(const Unit &inunit) const
Quantum<Vector<Double> > getAngle() const
Quantum<Vector<Double> > getAngle(const Unit &inunit) const

Get Measure data

virtual Measure *clone() const

Make copy