#include <MEarthMagnetic.h>
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. More... | |
| typedef MCEarthMagnetic | MCType |
| Measure conversion routines for this class (i.e. More... | |
| typedef MeasRef< MEarthMagnetic > | Ref |
| Measure reference (i.e. More... | |
| typedef MeasConvert< MEarthMagnetic > | Convert |
| Measure Convert (i.e. More... | |
| typedef ScalarMeasColumn< MEarthMagnetic > | ScalarColumn |
| Measure table Columns (e.g., MEarthMagnetic::ScalarColumn) More... | |
| typedef ArrayMeasColumn< MEarthMagnetic > | 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 | |
| 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 More... | |
| MEarthMagnetic (const MVEarthMagnetic &dt) | |
| Create from data and reference. More... | |
| 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 |
| Tell me your type. More... | |
| 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) More... | |
| virtual Bool | setRefString (const String &in) |
| Set the reference type to the specified String. More... | |
| virtual const String & | getDefaultType () const |
| Get the default reference type. More... | |
| virtual const String * | allTypes (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 > > | get (const Unit &inunit) const |
| Get Measure data. More... | |
| Quantum< Vector< Double > > | getAngle () const |
| Quantum< Vector< Double > > | getAngle (const Unit &inunit) const |
| virtual Measure * | clone () const |
| Make copy. More... | |
| Public Member Functions inherited from casacore::MeasBase< MVEarthMagnetic, MeasRef< MEarthMagnetic > > | |
| 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< MVEarthMagnetic, MeasRef< MEarthMagnetic > > &other) | |
| Copy constructor. More... | |
| MeasBase (const MVEarthMagnetic &dt, const MeasRef< MEarthMagnetic > &rf) | |
| Create from data and reference. More... | |
| MeasBase (const MVEarthMagnetic &dt, uInt rf) | |
| MeasBase (const Quantity &dt, const MeasRef< MEarthMagnetic > &rf) | |
| MeasBase (const Quantity &dt, uInt rf) | |
| MeasBase (const Measure *dt) | |
| MeasBase (const MeasRef< MEarthMagnetic > &rf) | |
| MeasBase (const uInt rf) | |
| MeasBase< MVEarthMagnetic, MeasRef< MEarthMagnetic > > & | operator= (const MeasBase< MVEarthMagnetic, MeasRef< MEarthMagnetic > > &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 MVEarthMagnetic &dt) |
| Refill the specified entities. More... | |
| void | set (const MeasRef< MEarthMagnetic > &rf) |
| void | set (const MVEarthMagnetic &dt, const MeasRef< MEarthMagnetic > &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< MEarthMagnetic > | getRef () const |
| Get reference. More... | |
| const MVEarthMagnetic & | getValue () const |
| Get Measure data. More... | |
| const Unit & | getUnit () const |
| Get Unit. More... | |
| virtual MRBase * | getRefPtr () const |
| Get reference pointer. More... | |
| virtual const MeasValue * | getData () 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 const String & | showMe () |
| static void | assure (const Measure &in) |
| static MEarthMagnetic::Types | castType (uInt tp) |
| Translate reference code. More... | |
| static const String & | showType (MEarthMagnetic::Types tp) |
| static const String & | showType (uInt tp) |
| static Bool | getType (MEarthMagnetic::Types &tp, const String &in) |
| Translate string to reference code. More... | |
| static const String * | allMyTypes (Int &nall, Int &nextra, const uInt *&typ) |
| static void | checkMyTypes () |
| 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< MEarthMagnetic > |
| Conversion of data. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from casacore::MeasBase< MVEarthMagnetic, MeasRef< MEarthMagnetic > > | |
| MVEarthMagnetic | data |
| The measure value (e.g. More... | |
| MeasRef< MEarthMagnetic > | ref |
| Reference frame data. More... | |
| Unit | unit |
| Possible input units. More... | |
Detailed Description
A Measure: Magnetic field on Earth
Intended use:
Public interface
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).
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
Motivation
To have the Earth' magnetic field in the standard Measure environment.
To Do
- maybe add other field models if necessary (e.g. dipole)
Definition at line 118 of file MEarthMagnetic.h.
Member Typedef Documentation
◆ ArrayColumn
Definition at line 179 of file MEarthMagnetic.h.
◆ Convert
◆ MCType
Measure conversion routines for this class (i.e.
Definition at line 172 of file MEarthMagnetic.h.
◆ MVType
Measure value container for this class (i.e.
Definition at line 170 of file MEarthMagnetic.h.
◆ Ref
◆ ScalarColumn
Measure table Columns (e.g., MEarthMagnetic::ScalarColumn)
Definition at line 178 of file MEarthMagnetic.h.
Member Enumeration Documentation
◆ Types
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();
Definition at line 133 of file MEarthMagnetic.h.
Constructor & Destructor Documentation
◆ MEarthMagnetic() [1/8]
| casacore::MEarthMagnetic::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() [2/8]
| casacore::MEarthMagnetic::MEarthMagnetic | ( | const MVEarthMagnetic & | dt | ) |
Create from data and reference.
◆ MEarthMagnetic() [3/8]
| casacore::MEarthMagnetic::MEarthMagnetic | ( | const MVEarthMagnetic & | dt, |
| const MEarthMagnetic::Ref & | rf | ||
| ) |
◆ MEarthMagnetic() [4/8]
| casacore::MEarthMagnetic::MEarthMagnetic | ( | const MVEarthMagnetic & | dt, |
| MEarthMagnetic::Types | rf | ||
| ) |
◆ MEarthMagnetic() [5/8]
| casacore::MEarthMagnetic::MEarthMagnetic | ( | const Measure * | dt | ) |
◆ MEarthMagnetic() [6/8]
| casacore::MEarthMagnetic::MEarthMagnetic | ( | const MeasValue * | dt | ) |
◆ MEarthMagnetic() [7/8]
| casacore::MEarthMagnetic::MEarthMagnetic | ( | const MEarthMagnetic::Ref & | rf | ) |
◆ MEarthMagnetic() [8/8]
| casacore::MEarthMagnetic::MEarthMagnetic | ( | const MEarthMagnetic & | ) |
◆ ~MEarthMagnetic()
|
virtual |
Member Function Documentation
◆ allMyTypes()
|
static |
◆ allTypes()
|
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()
|
static |
◆ castType()
|
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()
|
static |
◆ checkTypes()
|
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 |
Make copy.
Implements casacore::Measure.
◆ get()
Get Measure data.
◆ getAngle() [1/2]
◆ getAngle() [2/2]
◆ getDefaultType()
|
virtual |
Get the default reference type.
Implements casacore::Measure.
◆ getRefString()
|
virtual |
Get the reference type (for records, including codes like R_)
Implements casacore::Measure.
◆ getType()
|
static |
Translate string to reference code.
◆ giveMe()
| Bool casacore::MEarthMagnetic::giveMe | ( | MEarthMagnetic::Ref & | mr, |
| const String & | in | ||
| ) |
◆ isModel()
|
virtual |
◆ operator=()
| MEarthMagnetic& casacore::MEarthMagnetic::operator= | ( | const MEarthMagnetic & | ) |
◆ setOffset()
Set the offset in the reference (False if non-matching Measure)
Implements casacore::Measure.
◆ setRefString()
Set the reference type to the specified String.
False if illegal string, reference set to DEFAULT.
Implements casacore::Measure.
◆ showMe()
|
static |
◆ showType() [1/2]
|
static |
◆ showType() [2/2]
◆ tellMe()
|
virtual |
Tell me your type.
Implements casacore::Measure.
Friends And Related Function Documentation
◆ MeasConvert< MEarthMagnetic >
|
friend |
Conversion of data.
Definition at line 1 of file MEarthMagnetic.h.
The documentation for this class was generated from the following file:
- measures/Measures/MEarthMagnetic.h
