Frame (OREKIT 12.0.1 API)

java.lang.Object
- org.orekit.frames.Frame

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CR3BPRotatingFrame, ExtendedPVCoordinatesProviderAdapter, FactoryManagedFrame, L1Frame, L2Frame, LocalOrbitalFrame, ModifiedFrame, TopocentricFrame, TwoBodiesBaryFrame, UpdatableFrame, VersionedITRF
```
public class Frame
extends Object
implements Serializable
```
三维参考系类。
参考系介绍

这个类是OREKIT中所有参考系的基类。这些参考系在树形结构中连接在一起，其中选择某个特定的参考系作为树的根。每个参考系由与其父参考系在树结构中的任意数量的平移和旋转组合的transforms定义。

当我们说一个从参考系_A到参考系_B的transform t，我们的意思是，如果某个绝对向量的坐标（例如远处星星的方向）在参考系_A中为u_A，在参考系_B中为u_B，那么u_B=t.transformVector(u_A)。

这些transforms可能是恒定的或变化的，取决于用于定义参考系的transform provider的实现。对于简单的固定transforms，使用FixedTransformProvider就足够了。对于变化的transforms（例如时间相关或基于遥测的transforms），可能有必要定义transform provider的特定实现。

Author:

Guylaine Prat, Luc Maisonobe, Pascal Parraud

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Frame(Frame parent, TransformProvider transformProvider, String name)` 从其相对于父参考系的transform构建非惯性参考系。
`Frame(Frame parent, TransformProvider transformProvider, String name, boolean pseudoInertial)` 从其相对于父参考系的transform构建参考系。
`Frame(Frame parent, Transform transform, String name)` 从其相对于父参考系的transform构建非惯性参考系。
`Frame(Frame parent, Transform transform, String name, boolean pseudoInertial)` 从其相对于父参考系的transform构建参考系。

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Frame`	`getAncestor(int n)` 获取参考系的第n个祖先。
`int`	`getDepth()` 获取参考系的深度。
`Frame`	`getFrozenFrame(Frame reference, AbsoluteDate freezingDate, String frozenName)` 获取实例的新版本，相对于一个参考系被冻结。
`String`	`getName()` 获取名称。
`Frame`	`getParent()` 获取父参考系。
`static Frame`	`getRoot()` 获取唯一的根参考系。
`StaticTransform`	`getStaticTransformTo(Frame destination, AbsoluteDate date)` 获取从实例到另一个参考系的transform的静态部分。
`<T extends org.hipparchus.CalculusFieldElement<T>> FieldStaticTransform<T>`	`getStaticTransformTo(Frame destination, FieldAbsoluteDate<T> date)` 获取从实例到另一个参考系的transform的静态部分。
`TransformProvider`	`getTransformProvider()` 获取从父参考系到实例的transform的提供者。
`Transform`	`getTransformTo(Frame destination, AbsoluteDate date)` 获取从实例到另一个参考系的transform。
`<T extends org.hipparchus.CalculusFieldElement<T>> FieldTransform<T>`	`getTransformTo(Frame destination, FieldAbsoluteDate<T> date)` 获取从实例到另一个参考系的transform。
`boolean`	`isChildOf(Frame potentialAncestor)` 确定一个参考系是否是另一个参考系的子参考系。
`boolean`	`isPseudoInertial()` 检查参考系是否是伪惯性的。
`String`	`toString()` java.util toString()方法的新定义。

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

- Constructor Detail
  - Frame
```
public Frame(Frame parent,
             Transform transform,
             String name)
      throws IllegalArgumentException
```
    从其相对于父参考系的transform构建非惯性参考系。
    调用这个构造函数等同于调用Frame(parent, transform, name, false)。
    
    参数：
    
    parent - 父参考系（不能为空）
    
    transform - 从父参考系到实例的transform
    
    name - 参考系的名称
    
    抛出：
    
    IllegalArgumentException - 如果父参考系为空
  - Frame
```
public Frame(Frame parent,
             TransformProvider transformProvider,
             String name)
      throws IllegalArgumentException
```
    从其相对于父参考系的transform构建非惯性参考系。
    调用这个构造函数等同于调用Frame(parent, transform, name, false)。
    
    参数：
    
    parent - 父参考系（不能为空）
    
    transformProvider - 从父参考系到实例的transform的提供者
    
    name - 参考系的名称
    
    抛出：
    
    IllegalArgumentException - 如果父参考系为空
  - Frame
```
public Frame(Frame parent,
             Transform transform,
             String name,
             boolean pseudoInertial)
      throws IllegalArgumentException
```
    从其相对于父参考系的transform构建参考系。
    transform的约定是从父参考系到实例。这意味着以下两个参考系是相似的：
```
 Frame frame1 = new Frame(FramesFactory.getGCRF(), new Transform(t1, t2));
 Frame frame2 = new Frame(new Frame(FramesFactory.getGCRF(), t1), t2);
 
```
    参数：
    
    parent - 父参考系（不能为空）
    
    transform - 从父参考系到实例的transform
    
    name - 参考系的名称
    
    pseudoInertial - 如果参考系被认为是伪惯性的（即适用于轨道的传播）
    
    抛出：
    
    IllegalArgumentException - 如果父参考系为空
  - Frame
```
public Frame(Frame parent,
             TransformProvider transformProvider,
             String name,
             boolean pseudoInertial)
      throws IllegalArgumentException
```
    从其相对于父参考系的transform构建参考系。
    transform的约定是从父参考系到实例。这意味着以下两个参考系是相似的：
```
 Frame frame1 = new Frame(FramesFactory.getGCRF(), new Transform(t1, t2));
 Frame frame2 = new Frame(new Frame(FramesFactory.getGCRF(), t1), t2);
 
```
    参数：
    
    parent - 父参考系（不能为空）
    
    transformProvider - 从父参考系到实例的transform的提供者
    
    name - 参考系的名称
    
    pseudoInertial - 如果参考系被认为是伪惯性的（即适用于轨道的传播）
    
    抛出：
    
    IllegalArgumentException - 如果父参考系为空
- Method Detail
  - getName
```
public String getName()
```
    获取名称。
    
    返回：
    
    名称
  - isPseudoInertial
```
public boolean isPseudoInertial()
```
    检查参考系是否是伪惯性的。
    伪惯性参考系是具有线性运动并且不旋转或旋转速率非常低以至于惯性力可以忽略的参考系。这意味着它们适用于使用牛顿力学定义和传播轨道。不是伪惯性的参考系不适用于定义和传播轨道。
    
    返回：
    
    如果参考系是伪惯性的则返回true
  - toString
```
public String toString()
```
    java.util toString()方法的新定义。
    
    覆盖：
    
    toString 在类 Object
    
    返回：
    
    名称
  - getParent
```
public Frame getParent()
```
    获取父参考系。
    
    返回：
    
    父参考系
  - getDepth
```
public int getDepth()
```
    获取参考系的深度。
    参考系的深度是它与参考系树根之间的父参考系数量。根参考系的深度为0，参考系的深度是其父参考系的深度加一。
    
    返回：
    
    参考系的深度
  - getAncestor
```
public Frame getAncestor(int n)
                  throws IllegalArgumentException
```
    获取参考系的第n个祖先。
    
    参数：
    
    n - 祖先的索引（0是实例，1是其父参考系，2是其父参考系的父参考系...）
    
    返回：
    
    参考系的第n个祖先（必须在0和参考系的深度之间）
    
    抛出：
    
    IllegalArgumentException - 如果n大于实例的深度
  - getTransformTo
```
public Transform getTransformTo(Frame destination,
                                AbsoluteDate date)
```
    获取从实例到另一个参考系的transform。
    
    参数：
    
    destination - 想要将向量转换到的目标参考系
    
    date - 日期（如果确定不使用日期相关的参考系则可以为空）
    
    返回：
    
    从实例到目标参考系的transform
  - getTransformTo
```
public <T extends org.hipparchus.CalculusFieldElement<T>> FieldTransform<T> getTransformTo(Frame destination,
                                                                                           FieldAbsoluteDate<T> date)
```
    获取从实例到另一个参考系的transform。
    
    类型参数：
    
    T - 字段元素的类型
    
    参数：
    
    destination - 想要将向量转换到的目标参考系
    
    date - 日期（如果确定不使用日期相关的参考系则可以为空）
    
    返回：
    
    从实例到目标参考系的transform
  - getStaticTransformTo
```
public StaticTransform getStaticTransformTo(Frame destination,
                                            AbsoluteDate date)
```
    获取从实例到另一个参考系的transform的静态部分。返回的transform在包括平移和旋转但不包括速率方面是静态的。
    当不需要速率时，这个方法通常比getTransformTo(Frame, AbsoluteDate)更高效。
    
    参数:
    
    destination - 要转换向量的目标参考系
    
    date - 日期（如果确定不使用依赖于日期的参考系，则可以为null）
    
    返回:
    
    从实例到目标参考系的静态变换
    
    自版本:
    
    11.2
  - getStaticTransformTo
```
public <T extends org.hipparchus.CalculusFieldElement<T>> FieldStaticTransform<T> getStaticTransformTo(Frame destination,
                                                                                                       FieldAbsoluteDate<T> date)
```
    获取从实例到另一个参考系的静态变换部分。返回的变换是静态的，即包括平移和旋转，但不包括速率。
    当不需要速率时，此方法通常比getTransformTo(Frame, FieldAbsoluteDate)更高效。
    
    首先对FieldAbsoluteDate进行检查，因为“fielded”变换性能较低。
    使用FieldElement.isZero()检查日期字段。
    如果为true，则使用未加字段的变换计算版本。
    
    类型参数:
    
    T - 元素的类型
    
    参数:
    
    destination - 要转换向量的目标参考系
    
    date - 日期（如果确定不使用依赖于日期的参考系，则可以为null）
    
    返回:
    
    从实例到目标参考系的静态变换
    
    自版本:
    
    12.0
  - getTransformProvider
```
public TransformProvider getTransformProvider()
```
    获取从父参考系到实例的变换提供程序。
    
    返回:
    
    从父参考系到实例的变换提供程序
  - isChildOf
```
public boolean isChildOf(Frame potentialAncestor)
```
    确定一个参考系是否是另一个参考系的子参考系。
    
    参数:
    
    potentialAncestor - 假定的祖先参考系
    
    返回:
    
    如果potentialAncestor属于从实例到根参考系的路径（不包括自身），则返回true
  - getRoot
```
public static Frame getRoot()
```
    获取唯一的根参考系。
    
    返回:
    
    唯一的根参考系实例
  - getFrozenFrame
```
public Frame getFrozenFrame(Frame reference,
                            AbsoluteDate freezingDate,
                            String frozenName)
```
    获取实例的新版本，相对于参考参考系冻结。
    冻结一个参考系意味着在某个冻结日期计算其相对于另一个参考系的位置和方向，并固定它们，使其不再依赖于时间。这意味着冻结的参考系相对于参考参考系是固定的。
    
    此方法的一个典型用途是通过在发射日期冻结一个地心参考系来计算惯性发射参考系。另一个用途是在参考历元日期冻结与春分相关的天体参考系。
    
    此方法返回的只有冻结的参考系，实例本身不受调用此方法的影响，仍然自由移动。
    
    参数:
    
    reference - 将实例冻结的参考参考系
    
    freezingDate - 冻结日期
    
    frozenName - 冻结参考系的名称
    
    返回:
    
    实例的冻结版本

Class Frame

参考系介绍

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Frame

Frame

Frame

Frame

Method Detail

getName

isPseudoInertial

toString

getParent

getDepth

getAncestor

getTransformTo

getTransformTo

getStaticTransformTo

getStaticTransformTo

getTransformProvider

isChildOf

getRoot

getFrozenFrame