EventSlopeFilter.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * The ASF licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *      http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  18. package org.orekit.propagation.events;

  20. import java.util.Arrays;

  22. import org.hipparchus.ode.events.Action;
  23. import org.orekit.propagation.SpacecraftState;
  24. import org.orekit.propagation.events.handlers.EventHandler;
  25. import org.orekit.time.AbsoluteDate;

  27. /** Wrapper used to detect only increasing or decreasing events.
  28.  *
  29.  * <p>This class is heavily based on the class EventFilter from the
  30.  * Hipparchus library. The changes performed consist in replacing
  31.  * raw types (double and double arrays) with space dynamics types
  32.  * ({@link AbsoluteDate}, {@link SpacecraftState}).</p>
  33.  *
  34.  * <p>General {@link EventDetector events} are defined implicitly
  35.  * by a {@link EventDetector#g(SpacecraftState) g function} crossing
  36.  * zero. This function needs to be continuous in the event neighborhood,
  37.  * and its sign must remain consistent between events. This implies that
  38.  * during an orbit propagation, events triggered are alternately events
  39.  * for which the function increases from negative to positive values,
  40.  * and events for which the function decreases from positive to
  41.  * negative values.
  42.  * </p>
  43.  *
  44.  * <p>Sometimes, users are only interested in one type of event (say
  45.  * increasing events for example) and not in the other type. In these
  46.  * cases, looking precisely for all events location and triggering
  47.  * events that will later be ignored is a waste of computing time.</p>
  48.  *
  49.  * <p>Users can wrap a regular {@link EventDetector event detector} in
  50.  * an instance of this class and provide this wrapping instance to
  51.  * a {@link org.orekit.propagation.Propagator}
  52.  * in order to avoid wasting time looking for uninteresting events.
  53.  * The wrapper will intercept the calls to the {@link
  54.  * EventDetector#g(SpacecraftState) g function} and to the {@link
  55.  * EventDetector#eventOccurred(SpacecraftState, boolean)
  56.  * eventOccurred} method in order to ignore uninteresting events. The
  57.  * wrapped regular {@link EventDetector event detector} will then see only
  58.  * the interesting events, i.e. either only {@code increasing} events or
  59.  * only {@code decreasing} events. The number of calls to the {@link
  60.  * EventDetector#g(SpacecraftState) g function} will also be reduced.</p>
  61.  * @see EventEnablingPredicateFilter
  62.  */

  64. public class EventSlopeFilter<T extends EventDetector> extends AbstractDetector<EventSlopeFilter<T>> {

  66.     /** Number of past transformers updates stored. */
  67.     private static final int HISTORY_SIZE = 100;

  69.     /** Wrapped event detector. */
  70.     private final T rawDetector;

  72.     /** Filter to use. */
  73.     private final FilterType filter;

  75.     /** Transformers of the g function. */
  76.     private final Transformer[] transformers;

  78.     /** Update time of the transformers. */
  79.     private final AbsoluteDate[] updates;

  81.     /** Indicator for forward integration. */
  82.     private boolean forward;

  84.     /** Extreme time encountered so far. */
  85.     private AbsoluteDate extremeT;

  87.     /** Wrap an {@link EventDetector event detector}.
  88.      * @param rawDetector event detector to wrap
  89.      * @param filter filter to use
  90.      */
  91.     public EventSlopeFilter(final T rawDetector, final FilterType filter) {
  92.         this(rawDetector.getMaxCheckInterval(), rawDetector.getThreshold(),
  93.              rawDetector.getMaxIterationCount(), new LocalHandler<T>(),
  94.              rawDetector, filter);
  95.     }

  97.     /** Private constructor with full parameters.
  98.      * <p>
  99.      * This constructor is private as users are expected to use the builder
  100.      * API with the various {@code withXxx()} methods to set up the instance
  101.      * in a readable manner without using a huge amount of parameters.
  102.      * </p>
  103.      * @param maxCheck maximum checking interval (s)
  104.      * @param threshold convergence threshold (s)
  105.      * @param maxIter maximum number of iterations in the event time search
  106.      * @param handler event handler to call at event occurrences
  107.      * @param rawDetector event detector to wrap
  108.      * @param filter filter to use
  109.      * @since 6.1
  110.      */
  111.     private EventSlopeFilter(final double maxCheck, final double threshold,
  112.                              final int maxIter, final EventHandler<? super EventSlopeFilter<T>> handler,
  113.                              final T rawDetector, final FilterType filter) {
  114.         super(maxCheck, threshold, maxIter, handler);
  115.         this.rawDetector  = rawDetector;
  116.         this.filter       = filter;
  117.         this.transformers = new Transformer[HISTORY_SIZE];
  118.         this.updates      = new AbsoluteDate[HISTORY_SIZE];
  119.     }

  121.     /** {@inheritDoc} */
  122.     @Override
  123.     protected EventSlopeFilter<T> create(final double newMaxCheck, final double newThreshold,
  124.                                          final int newMaxIter, final EventHandler<? super EventSlopeFilter<T>> newHandler) {
  125.         return new EventSlopeFilter<T>(newMaxCheck, newThreshold, newMaxIter, newHandler, rawDetector, filter);
  126.     }

  128.     /**
  129.      * Get the wrapped raw detector.
  130.      * @return the wrapped raw detector
  131.      * @since 11.1
  132.      */
  133.     public EventDetector getDetector() {
  134.         return rawDetector;
  135.     }

  137.     /**  {@inheritDoc} */
  138.     public void init(final SpacecraftState s0,
  139.                      final AbsoluteDate t) {
  140.         super.init(s0, t);

  142.         // delegate to raw detector
  143.         rawDetector.init(s0, t);

  145.         // initialize events triggering logic
  146.         forward  = t.compareTo(s0.getDate()) >= 0;
  147.         extremeT = forward ? AbsoluteDate.PAST_INFINITY : AbsoluteDate.FUTURE_INFINITY;
  148.         Arrays.fill(transformers, Transformer.UNINITIALIZED);
  149.         Arrays.fill(updates, extremeT);

  151.     }

  153.     /**  {@inheritDoc} */
  154.     public double g(final SpacecraftState s) {

  156.         final double rawG = rawDetector.g(s);

  158.         // search which transformer should be applied to g
  159.         if (forward) {
  160.             final int last = transformers.length - 1;
  161.             if (extremeT.compareTo(s.getDate()) < 0) {
  162.                 // we are at the forward end of the history

  164.                 // check if a new rough root has been crossed
  165.                 final Transformer previous = transformers[last];
  166.                 final Transformer next     = filter.selectTransformer(previous, rawG, forward);
  167.                 if (next != previous) {
  168.                     // there is a root somewhere between extremeT and t.
  169.                     // the new transformer is valid for t (this is how we have just computed
  170.                     // it above), but it is in fact valid on both sides of the root, so
  171.                     // it was already valid before t and even up to previous time. We store
  172.                     // the switch at extremeT for safety, to ensure the previous transformer
  173.                     // is not applied too close of the root
  174.                     System.arraycopy(updates,      1, updates,      0, last);
  175.                     System.arraycopy(transformers, 1, transformers, 0, last);
  176.                     updates[last]      = extremeT;
  177.                     transformers[last] = next;
  178.                 }

  180.                 extremeT = s.getDate();

  182.                 // apply the transform
  183.                 return next.transformed(rawG);

  185.             } else {
  186.                 // we are in the middle of the history

  188.                 // select the transformer
  189.                 for (int i = last; i > 0; --i) {
  190.                     if (updates[i].compareTo(s.getDate()) <= 0) {
  191.                         // apply the transform
  192.                         return transformers[i].transformed(rawG);
  193.                     }
  194.                 }

  196.                 return transformers[0].transformed(rawG);

  198.             }
  199.         } else {
  200.             if (s.getDate().compareTo(extremeT) < 0) {
  201.                 // we are at the backward end of the history

  203.                 // check if a new rough root has been crossed
  204.                 final Transformer previous = transformers[0];
  205.                 final Transformer next     = filter.selectTransformer(previous, rawG, forward);
  206.                 if (next != previous) {
  207.                     // there is a root somewhere between extremeT and t.
  208.                     // the new transformer is valid for t (this is how we have just computed
  209.                     // it above), but it is in fact valid on both sides of the root, so
  210.                     // it was already valid before t and even up to previous time. We store
  211.                     // the switch at extremeT for safety, to ensure the previous transformer
  212.                     // is not applied too close of the root
  213.                     System.arraycopy(updates,      0, updates,      1, updates.length - 1);
  214.                     System.arraycopy(transformers, 0, transformers, 1, transformers.length - 1);
  215.                     updates[0]      = extremeT;
  216.                     transformers[0] = next;
  217.                 }

  219.                 extremeT = s.getDate();

  221.                 // apply the transform
  222.                 return next.transformed(rawG);

  224.             } else {
  225.                 // we are in the middle of the history

  227.                 // select the transformer
  228.                 for (int i = 0; i < updates.length - 1; ++i) {
  229.                     if (s.getDate().compareTo(updates[i]) <= 0) {
  230.                         // apply the transform
  231.                         return transformers[i].transformed(rawG);
  232.                     }
  233.                 }

  235.                 return transformers[updates.length - 1].transformed(rawG);

  237.             }
  238.         }

  240.     }

  242.     /** Local handler. */
  243.     private static class LocalHandler<T extends EventDetector> implements EventHandler<EventSlopeFilter<T>> {

  245.         /** {@inheritDoc} */
  246.         public Action eventOccurred(final SpacecraftState s, final EventSlopeFilter<T> ef, final boolean increasing) {
  247.             return ef.rawDetector.eventOccurred(s, ef.filter.getTriggeredIncreasing());
  248.         }

  250.         /** {@inheritDoc} */
  251.         @Override
  252.         public SpacecraftState resetState(final EventSlopeFilter<T> ef, final SpacecraftState oldState) {
  253.             return ef.rawDetector.resetState(oldState);
  254.         }

  256.     }

  258. }
Created with JaCoCo 0.8.8.202204050719