GeoMagneticField (OREKIT 12.0.1 API)

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

```
public class GeoMagneticField
extends Object
```
用于计算地球上给定大地点处的地磁场。该计算是使用地磁势的球谐展开估算的，其系数由实际地磁场模型（例如IGRF，WMM）提供。
基于美国国家海洋和大气管理局（NOAA）国家地球物理数据中心的Manoj Nair编写的原始软件，作为WMM 2010软件发布的一部分（WMM_SubLibrary.c）

Author:

Thomas Neidhart

See Also:

World Magnetic Model Overview, WMM Software Downloads

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GeoMagneticField(String modelName, double epoch, int maxN, int maxNSec, double validityStart, double validityEnd)` 创建具有给定参数的新地磁场模型。

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GeoMagneticElements`	`calculateField(double latitude, double longitude, double height)` 计算指定大地点的磁场，由纬度、经度和海拔标识。
`static double`	`getDecimalYear(int day, int month, int year)` 获取给定日期的十进制年份的实用函数。
`double`	`getEpoch()` 返回此磁场模型的时代。
`String`	`getModelName()` 返回模型名称。
`protected void`	`setMainFieldCoefficients(int n, int m, double gnm, double hnm)` 设置给定的主场系数。
`protected void`	`setSecularVariationCoefficients(int n, int m, double dgnm, double dhnm)` 设置给定的岁差系数。
`boolean`	`supportsTimeTransform()` 指示此模型是否支持时间转换。
`GeoMagneticField`	`transformModel(double year)` 使用岁差系数从模型的基准年转换模型系数。
`GeoMagneticField`	`transformModel(GeoMagneticField otherModel, double year)` 使用第二个模型进行线性插值，从模型的基准年转换模型系数。
`double`	`validFrom()` 返回此模型的有效期开始。
`double`	`validTo()` 返回此模型的有效期结束。

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

- Constructor Detail
  - GeoMagneticField
```
protected GeoMagneticField(String modelName,
                           double epoch,
                           int maxN,
                           int maxNSec,
                           double validityStart,
                           double validityEnd)
```
    使用给定参数创建新的地磁场模型。根据指定的主要和岁差变化的程度初始化内部结构。
    
    参数：
    
    modelName - 模型名称
    
    epoch - 模型的时代
    
    maxN - 主模型的最大程度
    
    maxNSec - 岁差变化的最大程度
    
    validityStart - 此模型的有效开始
    
    validityEnd - 此模型的有效结束
- Method Detail
  - getEpoch
```
public double getEpoch()
```
    返回此磁场模型的时代。
    
    返回：
    
    时代
  - getModelName
```
public String getModelName()
```
    返回模型名称。
    
    返回：
    
    模型名称
  - validFrom
```
public double validFrom()
```
    返回此模型的有效期开始。
    
    返回：
    
    有效开始的十进制年份
  - validTo
```
public double validTo()
```
    返回此模型的有效期结束。
    
    返回：
    
    有效结束的十进制年份
  - supportsTimeTransform
```
public boolean supportsTimeTransform()
```
    指示此模型是否支持时间转换。
    
    返回：
    
    true如果此模型可以在其有效期内转换，否则false
  - setMainFieldCoefficients
```
protected void setMainFieldCoefficients(int n,
                                        int m,
                                        double gnm,
                                        double hnm)
```
    设置给定的主场系数。
    
    参数：
    
    n - n指数
    
    m - m指数
    
    gnm - n,m位置处的g系数
    
    hnm - n,m位置处的h系数
  - setSecularVariationCoefficients
```
protected void setSecularVariationCoefficients(int n,
                                               int m,
                                               double dgnm,
                                               double dhnm)
```
    设置给定的岁差系数。
    
    参数：
    
    n - n指数
    
    m - m指数
    
    dgnm - n,m位置处的dg系数
    
    dhnm - n,m位置处的dh系数
  - calculateField
```
public GeoMagneticElements calculateField(double latitude,
                                          double longitude,
                                          double height)
```
    计算由纬度、经度和海拔标识的指定大地点处的磁场。
    
    参数：
    
    latitude - 以弧度表示的WGS84纬度
    
    longitude - 以弧度表示的WGS84经度
    
    height - WGS84椭球体上方的高度，以米为单位
    
    返回：
    
    在给定大地点处的GeoMagneticElements
  - transformModel
```
public GeoMagneticField transformModel(double year)
```
    使用岁差系数从模型的基准年转换模型系数。
    
    参数：
    
    year - 要将模型转换为的年份
    
    返回：
    
    一个经过时间转换的磁场模型
  - transformModel
```
public GeoMagneticField transformModel(GeoMagneticField otherModel,
                                       double year)
```
    使用第二个模型进行线性插值，从模型的基准年转换模型系数。要求第二个模型具有相邻的有效期。
    
    参数：
    
    otherModel - 另一个磁场模型
    
    year - 要将模型转换为的年份
    
    返回：
    
    一个经过时间转换的磁场模型
  - getDecimalYear
```
public static double getDecimalYear(int day,
                                    int month,
                                    int year)
```
    获取给定日期的十进制年份的实用函数。
    
    参数：
    
    day - 日（1-31）
    
    month - 月（1-12）
    
    year - 年
    
    返回：
    
    给定日期表示的十进制年份

Class GeoMagneticField

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GeoMagneticField

Method Detail

getEpoch

getModelName

validFrom

validTo

supportsTimeTransform

setMainFieldCoefficients

setSecularVariationCoefficients

calculateField

transformModel

transformModel

getDecimalYear