Class LatitudeExtremumDetector

  • All Implemented Interfaces:
    EventDetector

    public class LatitudeExtremumDetector
    extends AbstractDetector<LatitudeExtremumDetector>
    Detector for geographic latitude extremum.

    This detector identifies when a spacecraft reaches its extremum latitudes with respect to a central body.

    Since:
    7.1
    Author:
    Luc Maisonobe
    • Constructor Detail

      • LatitudeExtremumDetector

        public LatitudeExtremumDetector​(double maxCheck,
                                        double threshold,
                                        OneAxisEllipsoid body)
        Build a detector.
        Parameters:
        maxCheck - maximal checking interval (s)
        threshold - convergence threshold (s)
        body - body on which the latitude is defined
      • LatitudeExtremumDetector

        protected LatitudeExtremumDetector​(AdaptableInterval maxCheck,
                                           double threshold,
                                           int maxIter,
                                           EventHandler handler,
                                           OneAxisEllipsoid body)
        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
        body - body on which the latitude is defined
    • Method Detail

      • create

        protected LatitudeExtremumDetector create​(AdaptableInterval newMaxCheck,
                                                  double newThreshold,
                                                  int newMaxIter,
                                                  EventHandler newHandler)
        Build a new instance.
        Specified by:
        create in class AbstractDetector<LatitudeExtremumDetector>
        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
      • getBody

        public BodyShape getBody()
        Get the body on which the geographic zone is defined.
        Returns:
        body on which the geographic zone is defined
      • g

        public double g​(SpacecraftState s)
        Compute the value of the detection function.

        The value is the spacecraft latitude time derivative.

        Specified by:
        g in interface EventDetector
        Specified by:
        g in class AbstractDetector<LatitudeExtremumDetector>
        Parameters:
        s - the current state information: date, kinematics, attitude
        Returns:
        spacecraft latitude time derivative