Package org.orekit.models.earth
Class GeoMagneticElements
java.lang.Object
org.orekit.models.earth.GeoMagneticElements
- All Implemented Interfaces:
Serializable
Contains the elements to represent a magnetic field at a single point.
- Author:
- Thomas Neidhart
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct a new element with the given field vector. -
Method Summary
Modifier and TypeMethodDescriptiondoubleReturns the declination of the magnetic field in radians.Returns the magnetic field vector in Tesla.doubleReturns the horizontal intensity of the magnetic field (= norm of the vector in the plane spanned by the x/y components of the field vector).doubleReturns the inclination of the magnetic field in radians.doubleReturns the total intensity of the magnetic field (= norm of the field vector).toString()
-
Constructor Details
-
GeoMagneticElements
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 Details
-
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
-