fr.cnes.sirius.patrius.covariance

Class AbstractOrbitalCovariance<T extends AbstractOrbitalCovariance<T>>

java.lang.Object

fr.cnes.sirius.patrius.covariance.AbstractOrbitalCovariance<T>

Type Parameters:

T - the type of orbital covariance represented by this class

All Implemented Interfaces:

TimeStamped, Serializable

Direct Known Subclasses:

MultiOrbitalCovariance, OrbitalCovariance

public abstract class AbstractOrbitalCovariance<T extends AbstractOrbitalCovariance<T>>
extends Object
implements TimeStamped, Serializable

Abstract representation of an orbital covariance.

An orbital covariance associates a Covariance instance with a given date and the frame, orbit type (Cartesian, Keplerian, etc) and position angle type (mean, true, eccentric) in which it is expressed.

Author:

Hugo Veuillez (CNES), Pierre Seimandi (GMV)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ORBIT_DIMENSION Number of orbital parameters.
protected static FieldDescriptor<OrbitalCoordinate>	ORBITAL_COORDINATE_DESCRIPTOR Field descriptor used to describe the orbital coordinates.

Constructor Summary

Constructors

Constructor and Description
AbstractOrbitalCovariance(Covariance covarianceIn, Frame frameIn, OrbitType orbitTypeIn, PositionAngle positionAngleIn) Creates a new instance from the supplied covariance, frame, orbit type and position angle type.
AbstractOrbitalCovariance(SymmetricPositiveMatrix covarianceIn, Frame frameIn, OrbitType orbitTypeIn, PositionAngle positionAngleIn) Creates a new instance from the supplied covariance matrix, frame, orbit type and position angle type.

Method Summary

Modifier and Type	Method and Description
protected void	checkCovarianceMatrixDimension() Checks the covariance matrix and throws an exception if its dimensions are not large enough to store the orbital parameters of a single orbit.
protected void	checkCovarianceMatrixDimension(int nbOrbits) Checks the covariance matrix and throws an exception if its dimensions are not large enough to store the orbital parameters of a given number of orbits.
protected void	checkOrbit(Orbit orbit) Checks an orbit and throws an exception if it is null, or if it is not defined at the same date as this orbital covariance.
protected void	checkParameterDescriptors() Checks that the first six parameter descriptors associated with the covariance have an orbital coordinate descriptor which is mapped to an OrbitalCoordinate instance with the expected state vector index.
protected void	checkParameterDescriptors(int startIndex, OrbitType expectedOrbitType) Starting from the specified index, checks that the first six parameter descriptors associated with the covariance have an orbital coordinate descriptor which is mapped to an OrbitalCoordinate instance with the expected state vector index.
protected static List<ParameterDescriptor>	convertParameterDescriptors(Collection<ParameterDescriptor> parameterDescriptors, OrbitType destOrbitType, PositionAngle destPositionAngle) Returns an updated list of parameter descriptors where the orbital coordinates mapped to the orbital coordinate descriptors were all converted to the specified orbit type and position angle type.
boolean	equals(Object object)
Covariance	getCovariance() Gets the covariance.
SymmetricPositiveMatrix	getCovarianceMatrix() Gets the covariance matrix.
Frame	getFrame() Gets the frame of the covariance.
OrbitType	getOrbitType() Gets the orbit type of covariance.
List<ParameterDescriptor>	getParameterDescriptors() Gets the parameter descriptors associated with the covariance matrix.
PositionAngle	getPositionAngle() Gets the position angle type of the covariance.
int	hashCode()
protected void	initParameterDescriptors(int startIndex, boolean replaceDescriptors) Starting from the specified index, adds the proper orbital coordinate descriptor to the first six parameter descriptors associated with the covariance matrix.
protected static <T extends Collection<?>> T	requireNonEmpty(T collection, String description) Checks a collection and throws an exception if it is null or empty.
protected static <T> T	requireNonNull(T object, String description) Checks an object and throws an exception if it is null.
String	toString() Returns a string representation of this orbital covariance which includes its date, frame, orbit type and position angle type, the associated parameter descriptors, but not the covariance matrix.
String	toString(RealMatrixFormat realMatrixFormat) Returns a string representation of this orbital covariance which includes its date, frame, orbit type and position angle type, the associated parameter descriptors, and the covariance matrix if the provided format is not null.
String	toString(RealMatrixFormat realMatrixFormat, TimeScale timeScale) Returns a string representation of this orbital covariance which includes its date, frame, orbit type and position angle type, the associated parameter descriptors, and the covariance matrix if the provided format is not null.
String	toString(RealMatrixFormat realMatrixFormat, TimeScale timeScale, String nameSeparator, String fieldSeparator, boolean printClassName, boolean reverseOrder) Returns a string representation of this instance which includes the name of the class (if requested), the names of the associated parameter descriptors and the the covariance matrix (if the specified matrix format is not null).
T	transformTo(Frame destFrame) Transforms this orbital covariance to the specified frame.
T	transformTo(Frame destFrame, OrbitType destOrbitType) Transforms this orbital covariance to the specified frame, orbit type.
abstract T	transformTo(Frame destFrame, OrbitType destOrbitType, PositionAngle destPositionAngle) Transforms this orbital covariance to the specified frame, orbit type and position angle type.
T	transformTo(OrbitType destOrbitType) Transforms this orbital covariance to the specified orbit type.
T	transformTo(OrbitType destOrbitType, PositionAngle destPositionAngle) Transforms this orbital covariance to the specified orbit type and position angle type.
T	transformTo(PositionAngle destPositionAngle) Transforms this orbital covariance to the specified position angle type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface fr.cnes.sirius.patrius.time.TimeStamped

getDate

Field Detail

ORBIT_DIMENSION

protected static final int ORBIT_DIMENSION

Number of orbital parameters.

See Also:

Constant Field Values

ORBITAL_COORDINATE_DESCRIPTOR

protected static final FieldDescriptor<OrbitalCoordinate> ORBITAL_COORDINATE_DESCRIPTOR

Field descriptor used to describe the orbital coordinates.

Constructor Detail

AbstractOrbitalCovariance

public AbstractOrbitalCovariance(SymmetricPositiveMatrix covarianceIn,
                                 Frame frameIn,
                                 OrbitType orbitTypeIn,
                                 PositionAngle positionAngleIn)

Creates a new instance from the supplied covariance matrix, frame, orbit type and position angle type.

Parameters:

covarianceIn - the covariance matrix

frameIn - the frame of the covariance

orbitTypeIn - the orbit type of the covariance

positionAngleIn - the position angle type of the covariance

Throws:

IllegalArgumentException - if any of the provided argument is null

AbstractOrbitalCovariance

public AbstractOrbitalCovariance(Covariance covarianceIn,
                                 Frame frameIn,
                                 OrbitType orbitTypeIn,
                                 PositionAngle positionAngleIn)

Creates a new instance from the supplied covariance, frame, orbit type and position angle type.

Parameters:

covarianceIn - the orbital covariance

frameIn - the frame of the covariance

orbitTypeIn - the orbit type of the covariance

positionAngleIn - the position angle type of the covariance

Throws:

IllegalArgumentException - if any of the provided argument is null

Method Detail

getCovariance

public Covariance getCovariance()

Gets the covariance.

Returns:

the covariance

getCovarianceMatrix

public SymmetricPositiveMatrix getCovarianceMatrix()

Gets the covariance matrix.

Returns:

the covariance matrix

getParameterDescriptors

public List<ParameterDescriptor> getParameterDescriptors()

Gets the parameter descriptors associated with the covariance matrix.

Returns:

the parameter descriptors associated with the covariance matrix

getFrame

public Frame getFrame()

Gets the frame of the covariance.

Returns:

the frame of the covariance

getOrbitType

public OrbitType getOrbitType()

Gets the orbit type of covariance.

Returns:

the orbit type of covariance

getPositionAngle

public PositionAngle getPositionAngle()

Gets the position angle type of the covariance.

Returns:

the position angle type of the covariance

transformTo

public abstract T transformTo(Frame destFrame,
                              OrbitType destOrbitType,
                              PositionAngle destPositionAngle)
                       throws PatriusException

Transforms this orbital covariance to the specified frame, orbit type and position angle type.

Important:
The use of non-Cartesian coordinates types may be incompatible with some frames (e.g. local orbital frames).

Parameters:

destFrame - the destination frame

destOrbitType - the destination orbit type

destPositionAngle - the destination position angle type

Returns:

the transformed orbital covariance

Throws:

PatriusException - if the orbital covariance cannot be transformed to the specified frame, orbit type and position angle type

transformTo

public T transformTo(Frame destFrame,
                     OrbitType destOrbitType)
              throws PatriusException

Transforms this orbital covariance to the specified frame, orbit type.

Important:
The use of non-Cartesian coordinates types may be incompatible with some frames (e.g. local orbital frames).

Parameters:

destFrame - the destination frame

destOrbitType - the destination orbit type

Returns:

the transformed orbital covariance

Throws:

PatriusException - if the orbital covariance cannot be transformed to the specified frame and orbit type

transformTo

public T transformTo(OrbitType destOrbitType,
                     PositionAngle destPositionAngle)
              throws PatriusException

Transforms this orbital covariance to the specified orbit type and position angle type.

Important:
The use of non-Cartesian coordinates types may be incompatible with some frames (e.g. local orbital frames).

Parameters:

destOrbitType - the destination orbit type

destPositionAngle - the destination position angle type

Returns:

the transformed orbital covariance

Throws:

PatriusException - if the orbital covariance cannot be transformed to the specified orbit type and position angle type

transformTo

public T transformTo(Frame destFrame)
              throws PatriusException

Transforms this orbital covariance to the specified frame.

Important:
The use of non-Cartesian coordinates types may be incompatible with some frames (e.g. local orbital frames).

Parameters:

destFrame - the destination frame

Returns:

the transformed orbital covariance

Throws:

PatriusException - if the orbital covariance cannot be transformed to the specified frame

transformTo

public T transformTo(OrbitType destOrbitType)
              throws PatriusException

Transforms this orbital covariance to the specified orbit type.

Important:
The use of non-Cartesian coordinates types may be incompatible with some frames (e.g. local orbital frames).

Parameters:

destOrbitType - the destination orbit type

Returns:

the transformed orbital covariance

Throws:

PatriusException - if the orbital covariance cannot be transformed to the specified orbit type

transformTo

public T transformTo(PositionAngle destPositionAngle)
              throws PatriusException

Transforms this orbital covariance to the specified position angle type.

Important:
The use of non-Cartesian coordinates types may be incompatible with some frames (e.g. local orbital frames).

Parameters:

destPositionAngle - the destination position angle type

Returns:

the transformed orbital covariance

Throws:

PatriusException - if the orbital covariance cannot be transformed to the specified position angle type

toString

public String toString()

Returns a string representation of this orbital covariance which includes its date, frame, orbit type and position angle type, the associated parameter descriptors, but not the covariance matrix.

The date is represented in the TAI time scale.

Overrides:

toString in class Object

Returns:

a string representation of the orbital covariance

toString

public String toString(RealMatrixFormat realMatrixFormat)

Returns a string representation of this orbital covariance which includes its date, frame, orbit type and position angle type, the associated parameter descriptors, and the covariance matrix if the provided format is not null.

The date is represented in the TAI time scale.

Parameters:

realMatrixFormat - the format used to represent the covariance matrix

Returns:

a string representation of the orbital covariance

toString

public String toString(RealMatrixFormat realMatrixFormat,
                       TimeScale timeScale)

Returns a string representation of this orbital covariance which includes its date, frame, orbit type and position angle type, the associated parameter descriptors, and the covariance matrix if the provided format is not null.

Parameters:

realMatrixFormat - the format used to represent the covariance matrix

timeScale - the time scale used to represent the date

Returns:

a string representation of the orbital covariance

toString

public String toString(RealMatrixFormat realMatrixFormat,
                       TimeScale timeScale,
                       String nameSeparator,
                       String fieldSeparator,
                       boolean printClassName,
                       boolean reverseOrder)

Returns a string representation of this instance which includes the name of the class (if requested), the names of the associated parameter descriptors and the the covariance matrix (if the specified matrix format is not null).

Parameters:

realMatrixFormat - the format used to represent the covariance matrix

timeScale - the time scale used to represent the date

nameSeparator - the string to use as a separator between the names of the parameter descriptors

fieldSeparator - the string to use as a separator between the field values of a parameter descriptor

printClassName - whether or not the name of this class should be printed

reverseOrder - whether or not the field values of each parameter descriptor should be printed in reverse order

Returns:

string representation of this instance

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

requireNonNull

protected static <T> T requireNonNull(T object,
                                      String description)

Checks an object and throws an exception if it is null.

Type Parameters:

T - the type of the object

Parameters:

object - the object to be checked

description - a short description of the object

Returns:

the specified object, if it is not null

Throws:

IllegalArgumentException - if the object is null

requireNonEmpty

protected static <T extends Collection<?>> T requireNonEmpty(T collection,
                                                             String description)

Checks a collection and throws an exception if it is null or empty.

Type Parameters:

T - the type of the collection

Parameters:

collection - the collection to be checked

description - a short description of the collection

Returns:

the specified collection, if it is not null nor empty

Throws:

IllegalArgumentException - if the collection is null or if the collection is empty

checkOrbit

protected void checkOrbit(Orbit orbit)

Checks an orbit and throws an exception if it is null, or if it is not defined at the same date as this orbital covariance.

Parameters:

orbit - the orbit to be checked

Throws:

IllegalArgumentException - if the orbit is null or if the orbit is not defined at the same date as the orbital covariance

checkCovarianceMatrixDimension

protected void checkCovarianceMatrixDimension()

Checks the covariance matrix and throws an exception if its dimensions are not large enough to store the orbital parameters of a single orbit.

checkCovarianceMatrixDimension

protected void checkCovarianceMatrixDimension(int nbOrbits)

Checks the covariance matrix and throws an exception if its dimensions are not large enough to store the orbital parameters of a given number of orbits.

Parameters:

nbOrbits - the number of orbits

Throws:

IllegalArgumentException - if the covariance matrix is not large enough to store the orbital parameters of the specified number of orbits

checkParameterDescriptors

protected void checkParameterDescriptors()

Checks that the first six parameter descriptors associated with the covariance have an orbital coordinate descriptor which is mapped to an OrbitalCoordinate instance with the expected state vector index.

Throws:

IllegalStateException - if one of the checked parameter descriptors does not have an orbital coordinate descriptor, or if it does, but it is mapped to an orbital coordinate with a wrong state vector index

checkParameterDescriptors

protected void checkParameterDescriptors(int startIndex,
                                         OrbitType expectedOrbitType)

Starting from the specified index, checks that the first six parameter descriptors associated with the covariance have an orbital coordinate descriptor which is mapped to an OrbitalCoordinate instance with the expected state vector index.

Parameters:

startIndex - the start index

expectedOrbitType - the orbital coordinate descriptor should be compatible with the expected orbit type

Throws:

IllegalStateException - if one of the checked parameter descriptors does not have an orbital coordinate descriptor, or if it does, but it is mapped to an orbital coordinate with a wrong state vector index

initParameterDescriptors

protected void initParameterDescriptors(int startIndex,
                                        boolean replaceDescriptors)

Starting from the specified index, adds the proper orbital coordinate descriptor to the first six parameter descriptors associated with the covariance matrix.

This method considers that the targeted parameter descriptors are the ones related to the orbital parameters, in the order defined by the OrbitalCoordinate classes ( CartesianCoordinate, KeplerianCoordinate, ...). If one of the parameter descriptors checked is already associated with an orbital coordinate descriptor, the behavior of the method depends on the replaceDescriptors argument. If it is set to true, the previously mapped value is simply ignored and replaced by the expected orbital coordinate. Otherwise, an exception is thrown.

Parameters:

startIndex - the start index

replaceDescriptors - whether or not to replace the values mapped to the existing orbital coordinate descriptors

Throws:

IllegalStateException - if replaceDescriptors is true and one of the parameter descriptors to initialize already have an orbital coordinate descriptor and it is mapped to an orbital coordinate that is not the one expected

convertParameterDescriptors

protected static List<ParameterDescriptor> convertParameterDescriptors(Collection<ParameterDescriptor> parameterDescriptors,
                                                                       OrbitType destOrbitType,
                                                                       PositionAngle destPositionAngle)

Returns an updated list of parameter descriptors where the orbital coordinates mapped to the orbital coordinate descriptors were all converted to the specified orbit type and position angle type.

Parameters:

parameterDescriptors - the parameter descriptors to be updated

destOrbitType - the destination orbit type

destPositionAngle - the destination position angle type

Returns:

the updated list of parameter descriptors