Class AltitudeDetector

    • Constructor Detail

      • AltitudeDetector

        public AltitudeDetector​(double altitude,
                                BodyShape bodyShape)
        Build a new altitude detector.

        This simple constructor takes default values for maximal checking interval (AbstractDetector.DEFAULT_MAXCHECK) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

        Parameters:
        altitude - threshold altitude value
        bodyShape - body shape with respect to which altitude should be evaluated
      • AltitudeDetector

        public AltitudeDetector​(double maxCheck,
                                double altitude,
                                BodyShape bodyShape)
        Build a new altitude detector.

        This simple constructor takes default value for convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

        The maximal interval between altitude checks should be smaller than the half duration of the minimal pass to handle, otherwise some short passes could be missed.

        Parameters:
        maxCheck - maximal checking interval (s)
        altitude - threshold altitude value (m)
        bodyShape - body shape with respect to which altitude should be evaluated
      • AltitudeDetector

        public AltitudeDetector​(double maxCheck,
                                double threshold,
                                double altitude,
                                BodyShape bodyShape)
        Build a new altitude detector.

        The maximal interval between altitude checks should be smaller than the half duration of the minimal pass to handle, otherwise some short passes could be missed.

        The maximal interval between altitude checks should be smaller than the half duration of the minimal pass to handle, otherwise some short passes could be missed.

        Parameters:
        maxCheck - maximal checking interval (s)
        threshold - convergence threshold (s)
        altitude - threshold altitude value (m)
        bodyShape - body shape with respect to which altitude should be evaluated
      • AltitudeDetector

        protected AltitudeDetector​(AdaptableInterval maxCheck,
                                   double threshold,
                                   int maxIter,
                                   EventHandler handler,
                                   double altitude,
                                   BodyShape bodyShape)
        Protected constructor with full parameters.

        This constructor is not public as users are expected to use the builder API with the various withXxx() methods to set up the instance in a readable manner without using a huge amount of parameters.

        Parameters:
        maxCheck - maximum checking interval
        threshold - convergence threshold (s)
        maxIter - maximum number of iterations in the event time search
        handler - event handler to call at event occurrences
        altitude - threshold altitude value (m)
        bodyShape - body shape with respect to which altitude should be evaluated
        Since:
        6.1
    • Method Detail

      • create

        protected AltitudeDetector create​(AdaptableInterval newMaxCheck,
                                          double newThreshold,
                                          int newMaxIter,
                                          EventHandler newHandler)
        Build a new instance.
        Specified by:
        create in class AbstractDetector<AltitudeDetector>
        Parameters:
        newMaxCheck - maximum checking interval (s)
        newThreshold - convergence threshold (s)
        newMaxIter - maximum number of iterations in the event time search
        newHandler - event handler to call at event occurrences
        Returns:
        a new instance of the appropriate sub-type
      • getAltitude

        public double getAltitude()
        Get the threshold altitude value.
        Returns:
        the threshold altitude value (m)
      • getBodyShape

        public BodyShape getBodyShape()
        Get the body shape.
        Returns:
        the body shape
      • g

        public double g​(SpacecraftState s)
        Compute the value of the switching function. This function measures the difference between the current altitude and the threshold altitude.
        Specified by:
        g in interface EventDetector
        Specified by:
        g in class AbstractDetector<AltitudeDetector>
        Parameters:
        s - the current state information: date, kinematics, attitude
        Returns:
        value of the switching function