fr.cnes.sirius.patrius.models.earth

Class GeoMagneticElements

java.lang.Object

fr.cnes.sirius.patrius.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 and Description
GeoMagneticElements(Vector3D bIn) Construct a new element with the given field vector.

Method Summary

Modifier and Type	Method and Description
double	getDeclination() Returns the declination of the magnetic field in degrees.
Vector3D	getFieldVector() Returns the magnetic field vector in the topocentric frame (North=X, East=Y, Nadir=Z) in nTesla.
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 degrees.
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 bIn)

Construct a new element with the given field vector. The other elements of the magnetic field are calculated from the field vector.

Parameters:

bIn - the magnetic field vector in the topocentric frame (North=X, East=Y, Nadir=Z)

Method Detail

getFieldVector

public Vector3D getFieldVector()

Returns the magnetic field vector in the topocentric frame (North=X, East=Y, Nadir=Z) in nTesla.

Returns:

the magnetic field vector in nTesla

getInclination

public double getInclination()

Returns the inclination of the magnetic field in degrees.

Returns:

the inclination (dip) in degrees

getDeclination

public double getDeclination()

Returns the declination of the magnetic field in degrees.

Returns:

the declination (dec) in degrees

getTotalIntensity

public double getTotalIntensity()

Returns the total intensity of the magnetic field (= norm of the field vector).

Returns:

the total intensity in nTesla

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 nTesla

toString

public String toString()

Overrides:

toString in class Object