ParameterDriver (OREKIT 12.0.1 API)

java.lang.Object
- org.orekit.utils.ParameterDriver

Direct Known Subclasses:

DateDriver, ParameterDriversList.DelegatingDriver
```
public class ParameterDriver
extends Object
```
允许驱动参数值的类。
此类通常用作估算算法（通常是轨道确定或优化器）和需要调整的物理模型中的内部参数之间的桥梁，或者是有限差分算法和需要稍微偏移的物理模型中的内部参数之间的桥梁。物理模型将向算法公开此类的一组实例，以便算法可以调用setValue(double, AbsoluteDate)方法来更新给定日期的参数值。一些参数驱动器在整个周期内只有1个值被估计/驱动（默认情况下构造函数）。另一些在几个周期/间隔上估计/驱动几个值。例如，如果对于每天估计一个拖动参数的时间段为3天，则将估计3个值，每个时间段一个值。为了允许估计多个值，PDriver具有名称和值TimeSpanMap作为属性。为了切割时间跨度映射，有两种选择：
- 被动切割调用addSpans(AbsoluteDate, AbsoluteDate, double)方法。给定开始日期、结束日期和驱动器的有效期（以秒为单位），addSpans(org.orekit.time.AbsoluteDate, org.orekit.time.AbsoluteDate, double)方法将在开始日期到结束日期之间的名称和值时间跨度映射中切割多个有效期间隔。此方法不应在轨道驱动器上调用，只能在过程开始时调用一次（例如在轨道确定的开始时）。警告：为了确保轨道确定的收敛性，必须明智选择开始、结束日期和驱动器周期性。每个间隔上必须有足够的测量数据，否则收敛性将无法达到或出现奇异矩阵。
- 主动切割调用addSpanAtDate(AbsoluteDate)方法。给定日期，该方法将切割值和名称时间跨度名称，以便在给定日期开始一个新跨度。可以根据需要多次调用此方法来切割时间映射。警告：为了确保轨道确定的收敛性，如果多次调用该方法，则必须明智选择开始日期。每个间隔上必须有足够的测量数据，否则收敛性将无法达到或出现奇异矩阵。
有几种方法可以在具有多个间隔上的参数的特定日期获取ParameterDriver值。
- 首先是步骤估计，也就是说，如果要在特定日期知道一个值，则返回的值是与日期对应的跨度开始的值。根据此定义，一个值将在整个跨度持续时间内保持不变，并且将是跨度开始的值。
- 连续估计，也就是说，当一个值要在日期t知道时，返回的值将是与日期t对应的跨度开始值和结束此跨度（也是下一个跨度的开始）之间的线性插值。目前未实现
每次设置值时，物理模型都将被通知，因为它将为此目的注册一个ParameterObserver。
此设计有两个主要目标。首先，它允许外部算法几乎匿名地驱动内部参数，因为它只需要获取此类的实例列表，而无需知道它们实际驱动的内容。其次，它允许物理模型不直接暴露其参数的设置器方法。为了能够修改参数值，算法必须检索参数驱动器。
Since:

8.0

Author:

Luc Maisonobe, Melina Vanel

See Also:

ParameterObserver

Constructor Summary

Constructors
Constructor and Description
`ParameterDriver(String name, double referenceValue, double scale, double minValue, double maxValue)` 简单构造函数。
`ParameterDriver(String name, TimeSpanMap<String> namesSpanMap, TimeSpanMap<Double> valuesSpanMap, double referenceValue, double scale, double minValue, double maxValue)` 从另一个参数驱动器信息（例如（对于`ParameterDriversList.DelegatingDriver`）创建一个新实例。在构造时，新参数被配置为未选择，参考日期设置为`null`。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addObserver(ParameterObserver observer)` 为此驱动器添加一个观察者。
`void`	`addSpanAtDate(AbsoluteDate spanStartDate)` 在给定开始日期的值和名称时间跨度映射中创建一个新跨度。
`void`	`addSpans(AbsoluteDate orbitDeterminationStartDate, AbsoluteDate orbitDeterminationEndDate, double validityPeriodForDriver)` 根据轨道确定的开始和结束以及驱动器周期性切割值和名称时间跨度映射。
`double`	`getMaxValue()` 获取最大参数值。
`double`	`getMinValue()` 获取最小参数值。
`String`	`getName()` 获取参数驱动器的通用名称。
`String`	`getNameSpan(AbsoluteDate date)` 获取特定日期的参数跨度的名称。
`TimeSpanMap<String>`	`getNamesSpanMap()` 获取ParameterDriver的当前名称跨度映射，根据值跨度映射和有效期间隔切割为间隔。
`int`	`getNbOfValues()` 获取要估计的值的数量，也就是说，数量。
`double`	`getNormalizedValue()` 获取标准化值。
`double`	`getNormalizedValue(AbsoluteDate date)` 获取特定日期的标准化值。
`List<ParameterObserver>`	`getObservers()` 获取此驱动器的观察者。
`AbsoluteDate`	`getReferenceDate()` 获取当前参考日期。
`double`	`getReferenceValue()` 获取参考参数值。
`double`	`getScale()` 获取比例。
`AbsoluteDate[]`	`getTransitionDates()` 获取拖动敏感模型的过渡日期`TimeSpanMap`。
`double`	`getValue()` 获取当前参数值。
`double`	`getValue(AbsoluteDate date)` 获取特定日期的当前参数值，取决于isContinuousEstimation值，返回的值将通过步骤估计或连续估计获得。
`org.hipparchus.analysis.differentiation.Gradient`	`getValue(int freeParameters, Map<String,Integer> indices)` 在特殊日期以梯度形式获取值。
`org.hipparchus.analysis.differentiation.Gradient`	`getValue(int freeParameters, Map<String,Integer> indices, AbsoluteDate date)` 在特殊日期以梯度形式获取值。
`double`	`getValueContinuousEstimation(AbsoluteDate date)` 在特定日期使用连续估计获取当前参数值。
`double[]`	`getValues()` 按时间顺序获取valueSpanMap的所有值。
`TimeSpanMap<Double>`	`getValueSpanMap()` 获取参数驱动器的值时间跨度映射。
`double`	`getValueStepEstimation(AbsoluteDate date)` 在特定日期使用步骤估计获取当前参数值。
`boolean`	`isContinuousEstimation()` 检查参数估计是否连续，也就是说，当一个值要在日期t知道时，返回的值将是在日期t对应的跨度开始值和结束值之间的插值（对应于下一个跨度的开始），连续估计。
`boolean`	`isSelected()` 检查参数是否已选择。
`void`	`removeObserver(ParameterObserver observer)` 移除一个观察者。
`void`	`replaceObserver(ParameterObserver oldObserver, ParameterObserver newObserver)` 替换一个观察者。
`void`	`setContinuousEstimation(boolean continuous)` 将参数估计设置为连续，默认为步骤估计。
`void`	`setMaxValue(double maxValue)` 设置最大参数值。
`void`	`setMinValue(double minValue)` 设置最小参数值。
`void`	`setName(String name)` 更改此参数驱动器的通用名称。
`void`	`setNormalizedValue(double normalized)` 在特定日期设置标准化值。
`void`	`setNormalizedValue(double normalized, AbsoluteDate date)` 在特定日期设置标准化值。
`void`	`setReferenceDate(AbsoluteDate newReferenceDate)` 设置参考日期。
`void`	`setReferenceValue(double referenceValue)` 设置参考参数值。
`void`	`setScale(double scale)` 设置比例。
`void`	`setSelected(boolean selected)` 配置参数选择状态。
`void`	`setValue(double newValue)` 设置参数值。
`void`	`setValue(double newValue, AbsoluteDate date)` 在特定日期设置参数值。
`void`	`setValueSpanMap(ParameterDriver driver)` 将当前参数值跨度映射设置为匹配另一个驱动器。为了保持一致性，更新有效期和名称跨度映射。
`String`	`toString()` 获取参数的文本表示。

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

- Constructor Detail
  - ParameterDriver
```
public ParameterDriver(String name,
                       TimeSpanMap<String> namesSpanMap,
                       TimeSpanMap<Double> valuesSpanMap,
                       double referenceValue,
                       double scale,
                       double minValue,
                       double maxValue)
```
    从另一个参数驱动器信息（例如（对于ParameterDriversList.DelegatingDriver）创建一个新实例。在构造时，新参数被配置为未选择，参考日期设置为null。validityPeriod、namesSpanMap和valueSpanMap。
    
    参数：
    
    name - 参数的通用名称
    
    namesSpanMap - 名称时间跨度映射。警告，Span的数量必须与validityPeriod和valueSpanMap一致（具有相同数量的Span和相同的过渡日期）
    
    valuesSpanMap - 值时间跨度映射
    
    referenceValue - 参数的参考值
    
    scale - 缩放因子，将参数值转换为无量纲（通常设置为参数的预期标准偏差），必须为非零
    
    minValue - 允许的最小值
    
    maxValue - 允许的最大值
    
    自：
    
    12.0
  - ParameterDriver
```
public ParameterDriver(String name,
                       double referenceValue,
                       double scale,
                       double minValue,
                       double maxValue)
```
    简单构造函数。
    在构造时，参数被配置为未选择，参考日期设置为null，值设置为referenceValue，有效期设置为0，因此默认情况下ParameterDriver将仅在从-INF到+INF的1个间隔上进行估计。要更改有效期，必须调用addSpans(AbsoluteDate, AbsoluteDate, double)方法。
    
    参数：
    
    name - 参数的名称
    
    referenceValue - 参数的参考值
    
    scale - 缩放因子，将参数值转换为无量纲（通常设置为参数的预期标准偏差），必须为非零
    
    minValue - 允许的最小值
    
    maxValue - 允许的最大值
- Method Detail
  - getNamesSpanMap
```
public TimeSpanMap<String> getNamesSpanMap()
```
    获取ParameterDriver的当前名称跨度映射，根据值跨度映射和有效期间隔切割。
    
    返回：
    
    当前名称跨度映射
    
    自：
    
    12.0
  - getValueSpanMap
```
public TimeSpanMap<Double> getValueSpanMap()
```
    获取ParameterDriver的值时间跨度映射。
    
    返回：
    
    值时间跨度映射
    
    自：
    
    12.0
  - setValueSpanMap
```
public void setValueSpanMap(ParameterDriver driver)
```
    将当前参数值跨度映射设置为匹配另一个驱动器。为了保持一致性，更新有效期和名称跨度映射。
    
    参数:
    
    driver - 要为当前驱动程序复制值跨度映射的驱动程序
    
    自版本:
    
    12.0
  - getNbOfValues
```
public int getNbOfValues()
```
    获取要估计的值的数量，即值跨度映射中存在的跨度数量
    
    返回:
    
    int 估计值的数量
    
    自版本:
    
    12.0
  - getTransitionDates
```
public AbsoluteDate[] getTransitionDates()
```
    获取拖动敏感模型的过渡日期 TimeSpanMap。
    
    返回:
    
    拖动敏感模型的过渡日期 TimeSpanMap
    
    自版本:
    
    12.0
  - getValues
```
public double[] getValues()
```
    按时间顺序获取valueSpanMap的所有值。
    
    返回:
    
    double[] 包含按时间顺序的valueSpanMap的值
  - addObserver
```
public void addObserver(ParameterObserver observer)
```
    为此驱动程序添加观察者。
    观察者 valueSpanMapChanged 方法在添加观察者时会自动调用一次，然后在每次值更改时调用。
    
    参数:
    
    observer - 要添加的观察者，同时正在更新
  - removeObserver
```
public void removeObserver(ParameterObserver observer)
```
    移除观察者。
    
    参数:
    
    observer - 要移除的观察者
    
    自版本:
    
    9.1
  - replaceObserver
```
public void replaceObserver(ParameterObserver oldObserver,
                            ParameterObserver newObserver)
```
    替换观察者。
    
    参数:
    
    oldObserver - 要替换的观察者
    
    newObserver - 要使用的新观察者
    
    自版本:
    
    10.1
  - getObservers
```
public List<ParameterObserver> getObservers()
```
    获取此驱动程序的观察者。
    
    返回:
    
    此驱动程序的观察者的不可修改视图
    
    自版本:
    
    9.1
  - getName
```
public String getName()
```
    获取参数驱动程序的通用名称。
    
    返回:
    
    名称
  - getNameSpan
```
public String getNameSpan(AbsoluteDate date)
```
    获取特定日期的参数跨度名称。
    
    参数:
    
    date - 要了解跨度名称的日期
    
    返回:
    
    日期处的名称时间跨度映射数据
  - setName
```
public void setName(String name)
```
    更改此参数驱动程序的通用名称。
    
    参数:
    
    name - 新名称
  - addSpans
```
public void addSpans(AbsoluteDate orbitDeterminationStartDate,
                     AbsoluteDate orbitDeterminationEndDate,
                     double validityPeriodForDriver)
```
    根据轨道确定开始和结束以及驱动程序周期性，切割值和名称时间跨度映射。
    例如，对于阻力系数，有效期将为1天=86400秒。在构造函数之后调用以使用所需参数驱动程序时间性切割时间轴，以便在所需间隔上进行估计。
    
    例如，只能在轨道确定开始时调用一次。如果调用多次，将引发异常。如果必须更改参数估计间隔，则必须创建新的ParameterDriver或应使用函数 addSpanAtDate(org.orekit.time.AbsoluteDate)。
    
    在DateDriver和任何ParameterDrivenDateIntervalDetector属性上不应调用此函数，因为对于dateDriver估计多个值是没有意义的。
    
    在轨道确定情况下，必须谨慎选择orbitDeterminationStartDate、orbitDeterminationEndDate和validityPeriodForDriver，确实，每个时间间隔应有足够的测量数据可用，否则轨道确定将无法收敛。
    
    参数:
    
    orbitDeterminationStartDate - 开始估计参数值的日期。
    
    orbitDeterminationEndDate - 停止估计参数值的日期。
    
    validityPeriodForDriver - 参数值有效的有效期（例如，阻力系数为1天）。警告，validityPeriod不应太短，否则轨道确定将无法收敛。
    
    自版本:
    
    12.0
  - addSpanAtDate
```
public void addSpanAtDate(AbsoluteDate spanStartDate)
```
    在给定开始日期的值和名称时间跨度映射中创建一个新跨度。如果多次调用此函数以在所需时间创建多个跨度，则必须注意选择明智的日期的重要性。实际上，如果执行轨道确定，如果跨度太短且包含的测量太少，则可能无法收敛或找到奇异矩阵。必须在任何计算之前调用（例如在轨道确定之前）。
    
    参数:
    
    spanStartDate - 参数值区间开始估计的所需开始日期。
    
    自版本:
    
    12.0
  - getReferenceValue
```
public double getReferenceValue()
```
    获取参考参数值。
    
    返回:
    
    参考参数值
  - setReferenceValue
```
public void setReferenceValue(double referenceValue)
```
    设置参考参数值。
    
    参数:
    
    referenceValue - 要设置的参考值。
    
    自版本:
    
    9.3
  - getMinValue
```
public double getMinValue()
```
    获取最小参数值。
    
    返回:
    
    最小参数值
  - setMinValue
```
public void setMinValue(double minValue)
```
    设置最小参数值。
    
    参数:
    
    minValue - 要设置的最小值。
    
    自版本:
    
    9.3
  - getMaxValue
```
public double getMaxValue()
```
    获取最大参数值。
    
    返回:
    
    最大参数值
  - setMaxValue
```
public void setMaxValue(double maxValue)
```
    设置最大参数值。
    
    参数:
    
    maxValue - 要设置的最大值。
    
    自版本:
    
    9.3
  - getScale
```
public double getScale()
```
    获取比例。
    
    返回:
    
    比例
  - setScale
```
public void setScale(double scale)
```
    设置比例。
    
    参数:
    
    scale - 要设置的比例。
    
    自版本:
    
    9.3
  - getNormalizedValue
```
public double getNormalizedValue(AbsoluteDate date)
```
    获取特定日期的归一化值。
    归一化值是一个无量纲值，适合作为优化过程中向量的一部分使用。它计算为(current - reference)/scale。
    
    参数:
    
    date - 要了解归一化值的日期
    
    返回:
    
    归一化值
  - getNormalizedValue
```
public double getNormalizedValue()
```
    获取归一化值。仅适用于其TimeSpanMap值上只有1个跨度的ParameterDriver（即未调用setPeriod方法的ParameterDriver），否则将引发异常。
    归一化值是一个无量纲值，适合作为优化过程中向量的一部分使用。它计算为(current - reference)/scale。
    
    返回:
    
    归一化值
  - setNormalizedValue
```
public void setNormalizedValue(double normalized,
                               AbsoluteDate date)
```
    在特定日期设置归一化值。
    归一化值是一个无量纲值，适合作为优化过程中向量的一部分使用。它计算为(current - reference)/scale。
    
    参数:
    
    date - 要设置归一化值的日期
    
    normalized - 值
  - setNormalizedValue
```
public void setNormalizedValue(double normalized)
```
    在特定日期设置归一化值。仅适用于其TimeSpanMap值上只有1个跨度的ParameterDriver（即未调用setPeriod方法的ParameterDriver），否则将引发异常。
    归一化值是一个无量纲值，适合作为优化过程中向量的一部分使用。它计算为(current - reference)/scale。
    
    参数:
    
    normalized - 值
  - getReferenceDate
```
public AbsoluteDate getReferenceDate()
```
    获取当前参考日期。
    
    返回:
    
    当前参考日期（如果从未设置过则为null）
    
    自版本:
    
    9.0
  - setReferenceDate
```
public void setReferenceDate(AbsoluteDate newReferenceDate)
```
    设置参考日期。
    
    参数:
    
    newReferenceDate - 新的参考日期
    
    自版本:
    
    9.0
  - getValue
```
public double getValue()
```
    获取当前参数值。仅适用于其TimeSpanMap值上只有1个跨度的ParameterDriver（即未调用setPeriod方法的ParameterDriver）
    
    返回:
    
    当前参数值
  - getValue
```
public double getValue(AbsoluteDate date)
```
    获取特定日期的当前参数值，取决于isContinuousEstimation值，返回的值将通过步骤估计或连续估计获得。
    
    参数:
    
    date - 要获取值的日期。仅当参数驱动器在整个轨道确定期间（而不是估计的有效期间）上估计了1个值时，日期值可以为null，然后将返回唯一估计的值，在这种情况下，日期也可以是任何值，返回的值将是相同的。此外，在这种特殊情况下，还可以调用getValue()。
    
    返回:
    
    指定日期的当前参数值，如果没有有效期（=在整个轨道确定期间估计的1个值），则为整个期间的值
  - getValueStepEstimation
```
public double getValueStepEstimation(AbsoluteDate date)
```
    获取特定日期的当前参数值，使用步长估计。
    
    参数:
    
    date - 要获取值的日期。仅当参数驱动器在整个轨道确定期间（而不是估计的有效期间）上估计了1个值时，日期值可以为null，然后将返回唯一估计的值，在这种情况下，日期也可以是任何值，返回的值将是相同的。此外，在这种特殊情况下，还可以调用getValue()。
    
    返回:
    
    指定日期的当前参数值，如果没有有效期（=在整个轨道确定期间估计的1个值），则为整个期间的值
  - getValueContinuousEstimation
```
public double getValueContinuousEstimation(AbsoluteDate date)
```
    获取特定日期的当前参数值，使用连续估计。
    
    参数:
    
    date - 要获取值的日期。仅当参数驱动器在整个轨道确定期间（而不是估计的有效期间）上估计了1个值时，日期值可以为null，然后将返回唯一估计的值，在这种情况下，日期也可以是任何值，返回的值将是相同的。此外，在这种特殊情况下，还可以调用getValue()。
    
    返回:
    
    指定日期的当前参数值，如果没有有效期（=在整个轨道确定期间估计的1个值），则为整个期间的值
    
    自版本:
    
    12.0
  - getValue
```
public org.hipparchus.analysis.differentiation.Gradient getValue(int freeParameters,
                                                                 Map<String,Integer> indices)
```
    在特定日期以梯度形式获取值。
    
    参数:
    
    freeParameters - 梯度中的自由参数总数
    
    indices - 在导数计算中的微分参数的索引
    
    返回:
    
    具有导数的值，如果在具有多个驱动值的PDriver上调用，则会抛出异常
    
    自版本:
    
    10.2
  - getValue
```
public org.hipparchus.analysis.differentiation.Gradient getValue(int freeParameters,
                                                                 Map<String,Integer> indices,
                                                                 AbsoluteDate date)
```
    在特定日期以梯度形式获取值。
    
    参数:
    
    freeParameters - 梯度中的自由参数总数
    
    indices - 在导数计算中的微分参数的索引，必须是跨度名称而不是驱动器名称
    
    date - 要获取值的日期。仅当参数驱动器在整个轨道确定期间（而不是估计的有效期间）上估计了1个值时，日期值可以为null，然后将返回唯一估计的值
    
    返回:
    
    具有导数的值
    
    自版本:
    
    10.2
  - setValue
```
public void setValue(double newValue,
                     AbsoluteDate date)
```
    在特定日期设置参数值。
    如果newValue低于getMinValue()，它将被静默设置为getMinValue()。如果newValue高于getMaxValue()，它将被静默设置为getMaxValue()。
    
    参数:
    
    date - 要设置值的日期。仅当参数驱动器在整个轨道确定期间（而不是估计的有效期间）上估计了1个值时，日期值可以为null
    
    newValue - 要设置的新值
  - setValue
```
public void setValue(double newValue)
```
    设置参数值。仅可用于其TimeSpanMap值上只有1个跨度的ParameterDriver（也就是说，未调用setPeriod方法）
    如果newValue低于getMinValue()，它将被静默设置为getMinValue()。如果newValue高于getMaxValue()，它将被静默设置为getMaxValue()。
    
    参数:
    
    newValue - 要设置的新值
  - setSelected
```
public void setSelected(boolean selected)
```
    配置参数选择状态。
    选择用于轨道确定中的估计参数，或用于计算偏导数矩阵。
    
    参数:
    
    selected - 如果为true，则参数已选择，否则将被固定
  - isSelected
```
public boolean isSelected()
```
    检查参数是否已选择。
    选择用于轨道确定中的估计参数，或用于计算偏导数矩阵。
    
    返回:
    
    如果参数已选择，则为true，如果未选择，则为false
  - setContinuousEstimation
```
public void setContinuousEstimation(boolean continuous)
```
    将参数估计设置为连续估计，默认为步长估计。
    连续估计：当要在日期t获取值时，返回的值将是对应于日期t的跨度的起始值和结束值之间的插值（对应于下一个跨度的开始）。
    
    步长估计：当要在日期t获取值时，返回的值将是对应于日期t的跨度的开始值，步长估计。
    
    参数:
    
    continuous - 如果为true，则参数将使用连续估计进行估计，如果为false，则使用步长估计。
  - isContinuousEstimation
```
public boolean isContinuousEstimation()
```
    检查参数估计是否连续，也就是说，当要在日期t获取值时，返回的值将是对应于日期t的跨度的起始值和结束值之间的插值（对应于下一个跨度的开始），连续估计。或者不连续，也就是说，当要在日期t获取值时，返回的值将是对应于日期t的跨度的开始值，步长估计。
    
    返回:
    
    如果连续估计/定义，则为true，如果步长估计/定义，则为false
    
    自版本:
    
    12.0
  - toString
```
public String toString()
```
    获取参数的文本表示。
    
    覆盖:
    
    toString 在类 Object中
    
    返回:
    
    参数的文本表示，形式为名称 = 值。

Class ParameterDriver

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParameterDriver

ParameterDriver

Method Detail

getNamesSpanMap

getValueSpanMap

setValueSpanMap

getNbOfValues

getTransitionDates

getValues

addObserver

removeObserver

replaceObserver

getObservers

getName

getNameSpan

setName

addSpans

addSpanAtDate

getReferenceValue

setReferenceValue

getMinValue

setMinValue

getMaxValue

setMaxValue

getScale

setScale

getNormalizedValue

getNormalizedValue

setNormalizedValue

setNormalizedValue

getReferenceDate

setReferenceDate

getValue

getValue

getValueStepEstimation

getValueContinuousEstimation

getValue

getValue

setValue

setValue

setSelected

isSelected

setContinuousEstimation

isContinuousEstimation

toString