Class LatitudeRangeCrossingDetector

  • All Implemented Interfaces:
    EventDetector

    public class LatitudeRangeCrossingDetector
    extends AbstractDetector<LatitudeRangeCrossingDetector>
    Detector for geographic latitude crossing.

    This detector identifies when a spacecraft crosses a fixed latitude range with respect to a central body.

    Since:
    12.0
    Author:
    Alberto Ferrero
    • Constructor Detail

      • LatitudeRangeCrossingDetector

        public LatitudeRangeCrossingDetector​(OneAxisEllipsoid body,
                                             double fromLatitude,
                                             double toLatitude)
        Build a new detector.

        The new instance uses default values for maximal checking interval (AbstractDetector.DEFAULT_MAX_CHECK) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

        Parameters:
        body - body on which the latitude is defined
        fromLatitude - latitude to be crossed, lower range boundary
        toLatitude - latitude to be crossed, upper range boundary
      • LatitudeRangeCrossingDetector

        public LatitudeRangeCrossingDetector​(double maxCheck,
                                             double threshold,
                                             OneAxisEllipsoid body,
                                             double fromLatitude,
                                             double toLatitude)
        Build a detector.
        Parameters:
        maxCheck - maximal checking interval (s)
        threshold - convergence threshold (s)
        body - body on which the latitude is defined
        fromLatitude - latitude to be crossed, lower range boundary
        toLatitude - latitude to be crossed, upper range boundary
      • LatitudeRangeCrossingDetector

        protected LatitudeRangeCrossingDetector​(EventDetectionSettings detectionSettings,
                                                EventHandler handler,
                                                OneAxisEllipsoid body,
                                                double fromLatitude,
                                                double toLatitude)
        Private constructor with full parameters.

        This constructor is private 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:
        detectionSettings - event detection settings
        handler - event handler to call at event occurrences
        body - body on which the latitude is defined
        fromLatitude - latitude to be crossed, lower range boundary
        toLatitude - latitude to be crossed, upper range boundary
        Since:
        13.0
    • Method Detail

      • getBody

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

        public double getFromLatitude()
        Get the fixed latitude range to be crossed (radians), lower boundary.
        Returns:
        fixed lower boundary latitude range to be crossed (radians)
      • getToLatitude

        public double getToLatitude()
        Get the fixed latitude range to be crossed (radians), upper boundary.
        Returns:
        fixed lower boundary latitude range to be crossed (radians)
      • g

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

        The value is positive if the spacecraft latitude is inside the latitude range. It is positive if the spacecraft is northward to lower boundary range and southward to upper boundary range, with respect to the fixed latitude range.

        Parameters:
        s - the current state information: date, kinematics, attitude
        Returns:
        positive if spacecraft inside the range