Class AlignmentDetector

    • Constructor Detail

      • AlignmentDetector

        public AlignmentDetector​(Orbit orbit,
                                 PVCoordinatesProvider body,
                                 double alignAngle)
        Build a new alignment detector.

        The orbit is used only to set an upper bound for the max check interval to period/3 and to set the convergence threshold according to orbit size.

        Parameters:
        orbit - initial orbit
        body - the body to align
        alignAngle - the alignment angle (rad)
      • AlignmentDetector

        public AlignmentDetector​(double maxCheck,
                                 double threshold,
                                 PVCoordinatesProvider body,
                                 double alignAngle)
        Build a new alignment detector.
        Parameters:
        maxCheck - maximum checking interval (s)
        threshold - convergence threshold (s)
        body - the body to align
        alignAngle - the alignment angle (rad)
      • AlignmentDetector

        public AlignmentDetector​(double threshold,
                                 Orbit orbit,
                                 PVCoordinatesProvider body,
                                 double alignAngle)
        Build a new alignment detector.

        The orbit is used only to set an upper bound for the max check interval to period/3.

        Parameters:
        threshold - convergence threshold (s)
        orbit - initial orbit
        body - the body to align
        alignAngle - the alignment angle (rad)
      • AlignmentDetector

        protected AlignmentDetector​(AdaptableInterval maxCheck,
                                    double threshold,
                                    int maxIter,
                                    EventHandler handler,
                                    PVCoordinatesProvider body,
                                    double alignAngle)
        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 (s)
        threshold - convergence threshold (s)
        maxIter - maximum number of iterations in the event time search
        handler - event handler to call at event occurrences
        body - the body to align
        alignAngle - the alignment angle (rad)
    • Method Detail

      • create

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

        public PVCoordinatesProvider getPVCoordinatesProvider()
        Get the body to align.
        Returns:
        the body to align
      • getAlignAngle

        public double getAlignAngle()
        Get the alignment angle (rad).
        Returns:
        the alignment angle
      • g

        public double g​(SpacecraftState s)
        Compute the value of the switching function. This function measures the difference between the alignment angle and the angle between the satellite position and the body position projection in the orbital plane.
        Specified by:
        g in interface EventDetector
        Specified by:
        g in class AbstractDetector<AlignmentDetector>
        Parameters:
        s - the current state information: date, kinematics, attitude
        Returns:
        value of the switching function