Class GroundFieldOfViewDetector

    • Constructor Detail

      • GroundFieldOfViewDetector

        public GroundFieldOfViewDetector​(Frame frame,
                                         FieldOfView fov)
        Build a new instance.

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

        Parameters:
        frame - the reference frame attached to the sensor.
        fov - Field Of View of the sensor.
        Since:
        10.1
      • GroundFieldOfViewDetector

        protected GroundFieldOfViewDetector​(EventDetectionSettings detectionSettings,
                                            EventHandler handler,
                                            Frame frame,
                                            FieldOfView fov)
        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:
        detectionSettings - event detection settings
        handler - event handler to call at event occurrences
        frame - the reference frame attached to the sensor.
        fov - Field Of View of the sensor.
        Since:
        13.0
    • Method Detail

      • getFrame

        public Frame getFrame()
        Get the sensor reference frame.
        Returns:
        the reference frame attached to the sensor.
      • getFOV

        public FieldOfView getFOV()
        Get the Field Of View.
        Returns:
        Field Of View
        Since:
        10.1
      • g

        public double g​(SpacecraftState s)
        Compute the value of the switching function. This function must be continuous (at least in its roots neighborhood), as the integrator will need to find its roots to locate the events.

        The g function value is the angular offset between the satellite and the Field Of View boundary. It is negative if the satellite is visible within the Field Of View and positive if it is outside of the Field Of View, including the margin.

        As per the previous definition, when the satellite enters the Field Of View, a decreasing event is generated, and when the satellite leaves the Field Of View, an increasing event is generated.

        Parameters:
        s - the current state information: date, kinematics, attitude
        Returns:
        value of the switching function