agi.foundation.geometry

Class GeometryTransformer.Advanced

java.lang.Object

agi.foundation.geometry.GeometryTransformer.Advanced

Enclosing class:

GeometryTransformer

public static class GeometryTransformer.Advanced
extends Object

Contains methods to obtain evaluators for less common situations.

Constructor Summary

Constructors

Constructor and Description
Advanced()

Method Summary

Modifier and Type	Method and Description
static AxesEvaluator	getTransformationFromPointsAxes(Point fromPoint, Axes to) Gets an evaluator that can be used to find the transformation from the axes in which a point is defined to a given axes.
static AxesEvaluator	getTransformationFromPointsAxes(Point fromPoint, Axes to, EvaluatorGroup group) Gets an evaluator that can be used to find the transformation from the axes in which a point is defined to a given axes.
static AxesEvaluator	getTransformationFromVectorsAxes(Vector fromVector, Axes to) Gets an evaluator that can be used to find the transformation from the axes in which a vector is defined to a given axes.
static AxesEvaluator	getTransformationFromVectorsAxes(Vector fromVector, Axes to, EvaluatorGroup group) Gets an evaluator that can be used to find the transformation from the axes in which a vector is defined to a given axes.
static PointEvaluator	observePointInOtherPointsFrame(Point pointToObserve, Point frameOwner) Gets an evaluator that can be used to observe the Motion<Cartesian> of a point at a given JulianDate in the reference frame in which another point is defined.
static PointEvaluator	observePointInOtherPointsFrame(Point pointToObserve, Point frameOwner, EvaluatorGroup group) Gets an evaluator that can be used to observe the Motion<Cartesian> of a point at a given JulianDate in the reference frame in which another point is defined.
static VectorEvaluator	observeVectorInOtherVectorsAxes(Vector vectorToObserve, Vector axesOwner) Gets an evaluator to observe the Motion<Cartesian> of a vector in the axes in which another vector is defined.
static VectorEvaluator	observeVectorInOtherVectorsAxes(Vector vectorToObserve, Vector axesOwner, EvaluatorGroup group) Gets an evaluator to observe the Motion<Cartesian> of a vector in the axes in which another vector is defined.
static VectorEvaluator	observeVectorInPointsAxes(Vector vector, Point point) Gets an evaluator to observe the Motion<Cartesian> representation of a vector in the axes in which a point is defined.
static VectorEvaluator	observeVectorInPointsAxes(Vector vector, Point point, EvaluatorGroup group) Gets an evaluator to observe the Motion<Cartesian> representation of a vector in the axes in which a point is defined.
static Axes	unwrap(Axes axes) Unwraps an AxesInAxes, AxesInVectorsAxes, or AxesInPointsAxes, returning the simple underlying Axes.
static Point	unwrap(Point point) Unwraps a PointInReferenceFrame or PointInPointsFrame, returning the simple underlying Point.
static ReferenceFrame	unwrap(ReferenceFrame frame) Unwraps both the Origin (get / set) and Axes (get / set) of a ReferenceFrame, returning a reference frame composed of the simple underlying Point and Axes.
static Vector	unwrap(Vector vector) Unwraps a VectorInAxes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Advanced

public Advanced()

Method Detail

observeVectorInPointsAxes

@Nonnull
public static VectorEvaluator observeVectorInPointsAxes(@Nonnull
                                                                  Vector vector,
                                                                  @Nonnull
                                                                  Point point)

Gets an evaluator to observe the Motion<Cartesian> representation of a vector in the axes in which a point is defined. Note that this will not account for any translational effects and the axes are considered to be the vector's basis. So if the vector is representing a velocity or boresight vector, observing the vector in the axes of a reference frame which is rotating and translating with respect to the vector's axes will only take into account the relative rotation as if the two basis axes were co-located when computing the vector's derivatives. To obtain a vector and its derivatives in a different frame, the vector needs to be created in that frame.

Parameters:

vector - The vector to observe

point - The vector is observed in the axes in which this point is defined.

Returns:

An evaluator to find the motion of a vector in a point's axes.

Throws:

ArgumentNullException - Thrown when vector or point is null.

observeVectorInPointsAxes

@Nonnull
public static VectorEvaluator observeVectorInPointsAxes(@Nonnull
                                                                  Vector vector,
                                                                  @Nonnull
                                                                  Point point,
                                                                  @Nonnull
                                                                  EvaluatorGroup group)

Gets an evaluator to observe the Motion<Cartesian> representation of a vector in the axes in which a point is defined. Note that this will not account for any translational effects and the axes are considered to be the vector's basis. So if the vector is representing a velocity or boresight vector, observing the vector in the axes of a reference frame which is rotating and translating with respect to the vector's axes will only take into account the relative rotation as if the two basis axes were co-located when computing the vector's derivatives. To obtain a vector and its derivatives in a different frame, the vector needs to be created in that frame.

Parameters:

vector - The vector to observe

point - The vector is observed in the axes in which this point is defined.

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

An evaluator to find the motion of a vector in a point's axes.

Throws:

ArgumentNullException - Thrown when vector, point, or group is null.

getTransformationFromPointsAxes

@Nonnull
public static AxesEvaluator getTransformationFromPointsAxes(@Nonnull
                                                                      Point fromPoint,
                                                                      @Nonnull
                                                                      Axes to)

Gets an evaluator that can be used to find the transformation from the axes in which a point is defined to a given axes. The transformation is represented by a Motion<UnitQuaternion, Cartesian> at a given JulianDate.

Parameters:

fromPoint - The evaluator finds the transformation from the axes in which this point is defined.

to - The evaluator finds the transformation to this axes.

Returns:

An evaluator to find the transformation from the axes in which a point is defined to another axes.

Throws:

ArgumentNullException - Thrown when fromPoint or to is null.

getTransformationFromPointsAxes

@Nonnull
public static AxesEvaluator getTransformationFromPointsAxes(@Nonnull
                                                                      Point fromPoint,
                                                                      @Nonnull
                                                                      Axes to,
                                                                      @Nonnull
                                                                      EvaluatorGroup group)

Gets an evaluator that can be used to find the transformation from the axes in which a point is defined to a given axes. The transformation is represented by a Motion<UnitQuaternion, Cartesian> at a given JulianDate.

Parameters:

fromPoint - The evaluator finds the transformation from the axes in which this point is defined.

to - The evaluator finds the transformation to this axes.

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

An evaluator to find the transformation from the axes in which a point is defined to another axes.

Throws:

ArgumentNullException - Thrown when fromPoint, to, or group is null.

getTransformationFromVectorsAxes

@Nonnull
public static AxesEvaluator getTransformationFromVectorsAxes(@Nonnull
                                                                       Vector fromVector,
                                                                       @Nonnull
                                                                       Axes to)

Gets an evaluator that can be used to find the transformation from the axes in which a vector is defined to a given axes. The transformation is represented by a Motion<UnitQuaternion, Cartesian> at a given JulianDate.

Parameters:

fromVector - The evaluator finds the transformation from the axes in which this vector is defined.

to - The evaluator finds the transformation to this axes.

Returns:

An evaluator to find the transformation from the axes in which a vector is defined to another axes.

Throws:

ArgumentNullException - Thrown when fromVector or to is null.

getTransformationFromVectorsAxes

@Nonnull
public static AxesEvaluator getTransformationFromVectorsAxes(@Nonnull
                                                                       Vector fromVector,
                                                                       @Nonnull
                                                                       Axes to,
                                                                       @Nonnull
                                                                       EvaluatorGroup group)

Gets an evaluator that can be used to find the transformation from the axes in which a vector is defined to a given axes. The transformation is represented by a Motion <UnitQuaternion, Cartesian> at a given JulianDate.

Parameters:

fromVector - The evaluator finds the transformation from the axes in which this vector is defined.

to - The evaluator finds the transformation to this axes.

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

An evaluator to find the transformation from the axes in which a vector is defined to another axes.

Throws:

ArgumentNullException - Thrown when fromVector, to, or group is null.

observePointInOtherPointsFrame

@Nonnull
public static PointEvaluator observePointInOtherPointsFrame(@Nonnull
                                                                      Point pointToObserve,
                                                                      @Nonnull
                                                                      Point frameOwner)

Gets an evaluator that can be used to observe the Motion<Cartesian> of a point at a given JulianDate in the reference frame in which another point is defined.

Parameters:

pointToObserve - The point to observe.

frameOwner - The point is observed in the reference frame in which this point is defined.

Returns:

An evaluator to find the motion of a point in another point's reference frame.

Throws:

ArgumentNullException - Thrown when pointToObserve or frameOwner is null.

observePointInOtherPointsFrame

@Nonnull
public static PointEvaluator observePointInOtherPointsFrame(@Nonnull
                                                                      Point pointToObserve,
                                                                      @Nonnull
                                                                      Point frameOwner,
                                                                      @Nonnull
                                                                      EvaluatorGroup group)

Gets an evaluator that can be used to observe the Motion<Cartesian> of a point at a given JulianDate in the reference frame in which another point is defined.

Parameters:

pointToObserve - The point to observe.

frameOwner - The point is observed in the reference frame in which this point is defined.

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

An evaluator to find the motion of a point in another point's reference frame.

Throws:

ArgumentNullException - Thrown when pointToObserve, frameOwner, or group is null.

observeVectorInOtherVectorsAxes

@Nonnull
public static VectorEvaluator observeVectorInOtherVectorsAxes(@Nonnull
                                                                        Vector vectorToObserve,
                                                                        @Nonnull
                                                                        Vector axesOwner)

Gets an evaluator to observe the Motion<Cartesian> of a vector in the axes in which another vector is defined. Note that this will not account for any translational effects and the axes are considered to be the vector's basis. So if the vector is representing a velocity or boresight vector, observing the vector in the axes of a reference frame which is rotating and translating with respect to the vector's axes will only take into account the relative rotation as if the two basis axes were colocated when computing the vector's derivatives. To obtain a vector and its derivatives in a different frame, the vector needs to be created in that frame.

Parameters:

vectorToObserve - The vector to observe.

axesOwner - The vector is observed in the axes in which this vector is defined.

Returns:

An evaluator to find the motion of a vector in another vector's axes.

Throws:

ArgumentNullException - Thrown when vectorToObserve or axesOwner is null.

observeVectorInOtherVectorsAxes

@Nonnull
public static VectorEvaluator observeVectorInOtherVectorsAxes(@Nonnull
                                                                        Vector vectorToObserve,
                                                                        @Nonnull
                                                                        Vector axesOwner,
                                                                        @Nonnull
                                                                        EvaluatorGroup group)

Gets an evaluator to observe the Motion<Cartesian> of a vector in the axes in which another vector is defined. Note that this will not account for any translational effects and the axes are considered to be the vector's basis. So if the vector is representing a velocity or boresight vector, observing the vector in the axes of a reference frame which is rotating and translating with respect to the vector's axes will only take into account the relative rotation as if the two basis axes were colocated when computing the vector's derivatives. To obtain a vector and its derivatives in a different frame, the vector needs to be created in that frame.

Parameters:

vectorToObserve - The vector to observe.

axesOwner - The vector is observed in the axes in which this vector is defined.

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

An evaluator to find the motion of a vector in another vector's axes.

Throws:

ArgumentNullException - Thrown when vectorToObserve, axesOwner, or group is null.

unwrap

public static Axes unwrap(Axes axes)

Unwraps an AxesInAxes, AxesInVectorsAxes, or AxesInPointsAxes, returning the simple underlying Axes. If the specified axes is not one of these types, it is returned unmodified.

Parameters:

axes - The axes to unwrap.

Returns:

The unwrapped axes.

unwrap

public static Point unwrap(Point point)

Unwraps a PointInReferenceFrame or PointInPointsFrame, returning the simple underlying Point. If the specified point is not one of these types, it is returned unmodified.

Parameters:

point - The point to unwrap.

Returns:

The unwrapped point.

unwrap

public static Vector unwrap(Vector vector)

Unwraps a VectorInAxes. VectorInPointsAxes, or VectorInVectorsAxes, returning the simple underlying Vector. If the specified vector is not one of these types, it is returned unmodified.

Parameters:

vector - The vector to unwrap.

Returns:

The unwrapped vector.

unwrap

@Nonnull
public static ReferenceFrame unwrap(@Nonnull
                                              ReferenceFrame frame)

Unwraps both the Origin (get / set) and Axes (get / set) of a ReferenceFrame, returning a reference frame composed of the simple underlying Point and Axes.

Parameters:

frame - The reference frame to unwrap.

Returns:

The unwrapped reference frame.

Throws:

ArgumentNullException - Thrown when frame is null.