Package org.orekit.ssa.metrics

Class ProbabilityOfCollision

java.lang.Object
org.orekit.ssa.metrics.ProbabilityOfCollision
public class ProbabilityOfCollision 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
    Description
    ProbabilityOfCollision(double value, double lowerLimit, double upperLimit, String probabilityOfCollisionMethodName, boolean isMaxProbability)
    Constructor.
    ProbabilityOfCollision(double value, String probabilityOfCollisionMethodName)
    Constructor with default values of 0 for the upper/lower limits and default false flag for maximum probability.
    ProbabilityOfCollision(double value, String probabilityOfCollisionMethodName, boolean isMaxProbability)
    Constructor with default values of 0 for the upper and lower limits.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    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.
    double
    getUpperLimit()
    Get upper limit of the probability of collision value.
    double
    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 Details

    • ProbabilityOfCollision

      public ProbabilityOfCollision(double 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

    • ProbabilityOfCollision

      public ProbabilityOfCollision(double 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

    • ProbabilityOfCollision

      public ProbabilityOfCollision(double value, double lowerLimit, double 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 Details

    • getValue

      public double getValue()
      Get value of the probability of collision.
      Returns:
      value of the probability of collision

    • getLowerLimit

      public double getLowerLimit()
      Get lower limit of the probability of collision value.
      Returns:
      lower limit of the probability of collision value, 0 by default

    • getUpperLimit

      public double 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