GeoMagneticElements (OREKIT 12.1.2 API)

java.lang.Object
- org.orekit.models.earth.GeoMagneticElements

All Implemented Interfaces:

Serializable
```
public class GeoMagneticElements
extends Object
implements Serializable
```
Contains the elements to represent a magnetic field at a single point.

Author:

Thomas Neidhart

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

GeoMagneticElements(Vector3D b)
Construct a new element with the given field vector.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`getDeclination()`	Returns the declination of the magnetic field in radians.
`Vector3D`	`getFieldVector()`	Returns the magnetic field vector in Tesla.
`double`	`getHorizontalIntensity()`	Returns the horizontal intensity of the magnetic field (= norm of the vector in the plane spanned by the x/y components of the field vector).
`double`	`getInclination()`	Returns the inclination of the magnetic field in radians.
`double`	`getTotalIntensity()`	Returns the total intensity of the magnetic field (= norm of the field vector).
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GeoMagneticElements
```
public GeoMagneticElements(Vector3D b)
```
    Construct a new element with the given field vector. The other elements of the magnetic field are calculated from the field vector.
    
    Parameters:
    
    b - the magnetic field vector
- Method Detail
  - getFieldVector
```
public Vector3D getFieldVector()
```
    Returns the magnetic field vector in Tesla.
    
    Returns:
    
    the magnetic field vector in Tesla
  - getInclination
```
public double getInclination()
```
    Returns the inclination of the magnetic field in radians.
    
    Returns:
    
    the inclination (dip) in radians
  - getDeclination
```
public double getDeclination()
```
    Returns the declination of the magnetic field in radians.
    
    Returns:
    
    the declination (dec) in radians
  - getTotalIntensity
```
public double getTotalIntensity()
```
    Returns the total intensity of the magnetic field (= norm of the field vector).
    
    Returns:
    
    the total intensity in Tesla
  - getHorizontalIntensity
```
public double getHorizontalIntensity()
```
    Returns the horizontal intensity of the magnetic field (= norm of the vector in the plane spanned by the x/y components of the field vector).
    
    Returns:
    
    the horizontal intensity in Tesla
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object