public final class Covariance6By6TwoBodyBlender extends DefinitionalObject
This should only be used in orbital regimes where two-body gravity is a reasonable first approximation.
| Constructor and Description |
|---|
Covariance6By6TwoBodyBlender(DateMotionCollection1<Cartesian> orbitStates,
DateMotionCollection1<Matrix> covarianceData)
Initializes a new instance.
|
Covariance6By6TwoBodyBlender(DateMotionCollection1<Cartesian> orbitStates,
DateMotionCollection1<Matrix> covarianceData,
ReferenceFrame orbitStatesFrame,
Axes covarianceAxes,
ReferenceFrame inertialPropagationFrame,
double gravitationalParameter)
Initializes a new instance.
|
Covariance6By6TwoBodyBlender(DateMotionCollection1<Cartesian> orbitStates,
IDateMotionCollection1<Matrix6By6Symmetric> covarianceData)
Initializes a new instance.
|
Covariance6By6TwoBodyBlender(DateMotionCollection1<Cartesian> orbitStates,
IDateMotionCollection1<Matrix6By6Symmetric> covarianceData,
ReferenceFrame orbitStatesFrame,
Axes covarianceAxes,
ReferenceFrame inertialPropagationFrame,
double gravitationalParameter)
Initializes a new instance.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(DefinitionalObject other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
protected int |
computeCurrentDefinitionHashCode()
Computes a hash code based on the current properties of this object.
|
void |
enumerateDependencies(DependencyEnumerator enumerator)
Enumerates the dependencies of this object by calling
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. |
Axes |
getCovarianceAxes()
|
DateMotionCollection1<Matrix> |
getCovarianceData()
Gets the covariance data that is used for blending.
|
double |
getDateTolerance()
|
DynamicMatrixEvaluator |
getEvaluator()
Gets an evaluator that blends the covariance information.
|
DynamicMatrixEvaluator |
getEvaluator(EvaluatorGroup group)
Gets an evaluator that blends the covariance information.
|
double |
getGravitationalParameter()
Gets the gravitational parameter of the central body that the spacecraft is orbiting.
|
ReferenceFrame |
getInertialPropagationFrame()
|
DateMotionCollection1<Cartesian> |
getOrbitStates()
|
ReferenceFrame |
getOrbitStatesFrame()
|
void |
setCovarianceAxes(Axes value)
|
void |
setCovarianceData(DateMotionCollection1<Matrix> value)
Sets the covariance data that is used for blending.
|
void |
setDateTolerance(double value)
|
void |
setGravitationalParameter(double value)
Sets the gravitational parameter of the central body that the spacecraft is orbiting.
|
void |
setInertialPropagationFrame(ReferenceFrame value)
|
void |
setOrbitStates(DateMotionCollection1<Cartesian> value)
|
void |
setOrbitStatesFrame(ReferenceFrame value)
|
static Matrix |
transformCovariance(Matrix originalCovariance,
Motion2<UnitQuaternion,Cartesian> axesTransformation)
Transforms a 6x6 covariance matrix into new axes.
|
areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic Covariance6By6TwoBodyBlender(DateMotionCollection1<Cartesian> orbitStates, @Nonnull IDateMotionCollection1<Matrix6By6Symmetric> covarianceData)
OrbitStatesFrame (get / set) and InertialPropagationFrame (get / set) are set to the inertial frame of
the instance of EarthCentralBody in the CentralBodiesFacet of the CalculationContext. Similarly, the
CovarianceAxes (get / set) are set to the Axes (get / set) of that inertial frame. The GravitationalParameter (get / set) is
set to that of the WorldGeodeticSystem1984.orbitStates - The position and velocity vectors of the spacecraft at the same times
as the covarianceData.covarianceData - The covariance data that is used for blending.ArgumentNullException - Thrown when covarianceData is null.public Covariance6By6TwoBodyBlender(DateMotionCollection1<Cartesian> orbitStates, DateMotionCollection1<Matrix> covarianceData)
OrbitStatesFrame (get / set) and InertialPropagationFrame (get / set) are set to the inertial frame of
the instance of EarthCentralBody in the CentralBodiesFacet of the CalculationContext. Similarly, the
CovarianceAxes (get / set) are set to the Axes (get / set) of that inertial frame. The GravitationalParameter (get / set) is
set to that of the WorldGeodeticSystem1984.
to theorbitStates - The position and velocity vectors of the spacecraft at the same times
as the covarianceData.covarianceData - The covariance data that is used for blending.public Covariance6By6TwoBodyBlender(DateMotionCollection1<Cartesian> orbitStates, @Nonnull IDateMotionCollection1<Matrix6By6Symmetric> covarianceData, ReferenceFrame orbitStatesFrame, Axes covarianceAxes, ReferenceFrame inertialPropagationFrame, double gravitationalParameter)
orbitStates - The position and velocity vectors of the spacecraft at the same times
as the covarianceData.covarianceData - The covariance data that is used for blending.orbitStatesFrame - The native reference frame of the orbitStates.covarianceAxes - The native axes of the covarianceData.inertialPropagationFrame - The inertial propagation frame that is used to propagate the orbitStates
and the covarianceData.gravitationalParameter - The gravitational parameter of the central body that the spacecraft is orbiting.ArgumentNullException - Thrown when covarianceData is null.public Covariance6By6TwoBodyBlender(DateMotionCollection1<Cartesian> orbitStates, DateMotionCollection1<Matrix> covarianceData, ReferenceFrame orbitStatesFrame, Axes covarianceAxes, ReferenceFrame inertialPropagationFrame, double gravitationalParameter)
orbitStates - The position and velocity vectors of the spacecraft at the same times
as the covarianceData.covarianceData - The covariance data that is used for blending.orbitStatesFrame - The native reference frame of the orbitStates.covarianceAxes - The native axes of the covarianceData.inertialPropagationFrame - The inertial propagation frame that is used to propagate the orbitStates
and the covarianceData.gravitationalParameter - The gravitational parameter of the central body that the spacecraft is orbiting.public Object clone(CopyContext context)
This method should be implemented to call a copy constructor on the class of the
object being cloned. The copy constructor should take the CopyContext as a parameter
in addition to the existing instance to copy. The copy constructor should first call
CopyContext.addObjectMapping(T, T) to identify the newly constructed instance
as a copy of the existing instance. It should then copy all fields, using
CopyContext.updateReference(T) to copy any reference fields.
A typical implementation of ICloneWithContext:
public static class MyClass implements ICloneWithContext {
public MyClass(MyClass existingInstance, CopyContext context) {
context.addObjectMapping(existingInstance, this);
someReference = context.updateReference(existingInstance.someReference);
}
@Override
public final Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
}
In general, all fields that are reference types should be copied with a call to
CopyContext.updateReference(T). There are a couple of exceptions:
If one of these exceptions applies, the CopyContext should be given an opportunity
to update the reference before the reference is copied explicitly. Use
CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns
the original object, indicating that the context does not have a replacement registered,
then copy the object manually by invoking a Clone method, a copy constructor, or by manually
constructing a new instance and copying the values.
alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}
If you are implementing an evaluator (a class that implements IEvaluator), the
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the
copy context constructor. Code duplication can be avoided by doing the following:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.
public MyClass(MyClass existingInstance, CopyContext context) {
super(existingInstance, context);
someReference = context.updateReference(existingInstance.someReference);
evaluatorReference = existingInstance.evaluatorReference;
updateEvaluatorReferences(context);
}
@Override
public void updateEvaluatorReferences(CopyContext context) {
evaluatorReference = context.updateReference(evaluatorReference);
}
@Override
public Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
private IEvaluator evaluatorReference;clone in interface ICloneWithContextclone in class DefinitionalObjectcontext - The context to use to perform the copy.protected boolean checkForSameDefinition(DefinitionalObject other)
true if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return false for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).checkForSameDefinition in class DefinitionalObjectother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
Covariance6By6TwoBodyBlender.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.computeCurrentDefinitionHashCode in class DefinitionalObjectpublic void enumerateDependencies(DependencyEnumerator enumerator)
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
Derived classes which contain additional dependencies MUST override this method, call the base
implementation, and enumerate dependencies introduced by the derived class.enumerateDependencies in interface IEnumerateDependenciesenumerateDependencies in class DefinitionalObjectenumerator - The enumerator that is informed of the dependencies of this object.public final DateMotionCollection1<Cartesian> getOrbitStates()
public final void setOrbitStates(DateMotionCollection1<Cartesian> value)
public final DateMotionCollection1<Matrix> getCovarianceData()
public final void setCovarianceData(DateMotionCollection1<Matrix> value)
public final double getGravitationalParameter()
public final void setGravitationalParameter(double value)
public final ReferenceFrame getOrbitStatesFrame()
public final void setOrbitStatesFrame(ReferenceFrame value)
public final Axes getCovarianceAxes()
public final void setCovarianceAxes(Axes value)
public final ReferenceFrame getInertialPropagationFrame()
public final void setInertialPropagationFrame(ReferenceFrame value)
public final double getDateTolerance()
OrbitStates (get / set)
and CovarianceData (get / set) are close enough to being equal. By default, this value is
Constants.Epsilon6.public final void setDateTolerance(double value)
OrbitStates (get / set)
and CovarianceData (get / set) are close enough to being equal. By default, this value is
Constants.Epsilon6.@Nonnull public final DynamicMatrixEvaluator getEvaluator()
@Nonnull public final DynamicMatrixEvaluator getEvaluator(@Nonnull EvaluatorGroup group)
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.ArgumentNullException - Thrown when group is null.PropertyInvalidException - Thrown when OrbitStates (get / set), CovarianceData (get / set)
OrbitStatesFrame (get / set), CovarianceAxes (get / set), or InertialPropagationFrame (get / set)
are null. Thrown when GravitationalParameter (get / set) is zero or negative. Thrown when
the DateTolerance (get / set) is negative. Thrown when
OrbitStates (get / set) and CovarianceData (get / set) do not have the same size information or their
date information is different by more than the DateTolerance (get / set). Thrown
when the sizes of OrbitStates (get / set) and CovarianceData (get / set) are less than two. Thrown when
the Order (get) of the OrbitStates (get / set) is less than one.ArithmeticException - Thrown when the date given to the DynamicMatrixEvaluator
created by this method is outside the date range of the covariance data.public static Matrix transformCovariance(Matrix originalCovariance, @Nonnull Motion2<UnitQuaternion,Cartesian> axesTransformation)
originalCovariance - The 6x6 covariance matrix in the original axes.axesTransformation - The axes transformation from the original axes to the new axes.