org.orekit.ssa.metrics

Class FieldProbabilityOfCollision<T extends org.hipparchus.CalculusFieldElement<T>>

java.lang.Object

org.orekit.ssa.metrics.FieldProbabilityOfCollision<T>

Type Parameters:

T - type of the field elements

public class FieldProbabilityOfCollision<T extends org.hipparchus.CalculusFieldElement<T>>
extends Object

Container for values relative to the probability of collision :

• Value of the probability of collision.
• Name of the method with which it was computed.
• Upper and lower limit of the value if the method provides them (such as Laas2015 for example).
• Flag defining if the probability was maximized in any way (such as Alfriend1999Max for example).

Since:

12.0

Author:

Vincent Cucchietti

Constructor Summary

Constructors

Constructor and Description
FieldProbabilityOfCollision(T value, String probabilityOfCollisionMethodName) Constructor with default values of 0 for the upper/lower limits and default false flag for maximum probability.
FieldProbabilityOfCollision(T value, String probabilityOfCollisionMethodName, boolean isMaxProbability) Constructor with default values of 0 for the upper and lower limits.
FieldProbabilityOfCollision(T value, T lowerLimit, T upperLimit, String probabilityOfCollisionMethodName, boolean isMaxProbability) Constructor.

Method Summary

Modifier and Type	Method and Description
T	getLowerLimit() Get lower limit of the probability of collision value.
String	getProbabilityOfCollisionMethodName() Get name of the probability computing method with which this probability was computed.
T	getUpperLimit() Get upper limit of the probability of collision value.
T	getValue() Get value of the probability of collision.
boolean	isMaxProbability() Get flag that defines if this probability of collision can be considered a maximum probability of collision.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldProbabilityOfCollision

public FieldProbabilityOfCollision(T value,
                                   String probabilityOfCollisionMethodName)

Constructor with default values of 0 for the upper/lower limits and default false flag for maximum probability.

Parameters:

value - value of the probability of collision

probabilityOfCollisionMethodName - name of the probability computing method with which this probability was computed

FieldProbabilityOfCollision

public FieldProbabilityOfCollision(T value,
                                   String probabilityOfCollisionMethodName,
                                   boolean isMaxProbability)

Constructor with default values of 0 for the upper and lower limits.

Parameters:

value - value of the probability of collision

probabilityOfCollisionMethodName - name of the probability computing method with which this probability was computed

isMaxProbability - flag defining if it has been computed using a maximum probability of collision method

FieldProbabilityOfCollision

public FieldProbabilityOfCollision(T value,
                                   T lowerLimit,
                                   T upperLimit,
                                   String probabilityOfCollisionMethodName,
                                   boolean isMaxProbability)

Constructor.

Parameters:

value - value of the probability of collision

lowerLimit - lower limit of the probability of collision

upperLimit - upper limit of the probability of collision

probabilityOfCollisionMethodName - name of the probability computing method with which this probability was computed

isMaxProbability - flag indicating if this method computes a maximum probability of collision

Method Detail

getValue

public T getValue()

Get value of the probability of collision.

Returns:

value of the probability of collision

getLowerLimit

public T getLowerLimit()

Get lower limit of the probability of collision value.

Returns:

lower limit of the probability of collision value, 0 by default

getUpperLimit

public T getUpperLimit()

Get upper limit of the probability of collision value.

Returns:

upper limit of the probability of collision value, 0 by default

getProbabilityOfCollisionMethodName

public String getProbabilityOfCollisionMethodName()

Get name of the probability computing method with which this probability was computed.

Returns:

name of the probability computing method with which this probability was computed

isMaxProbability

public boolean isMaxProbability()

Get flag that defines if this probability of collision can be considered a maximum probability of collision.

Returns:

flag that defines if this probability of collision can be considered a maximum probability of collision