SimpleRatioAmbiguityAcceptance.java

  1. /* Copyright 2002-2024 CS GROUP
  2.  * Licensed to CS GROUP (CS) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * CS 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.  */
  17. package org.orekit.estimation.measurements.gnss;

  18. /** Ambiguity acceptance test based on a ratio of the two best candidates.
  19.  * @see AmbiguitySolver
  20.  * @author Luc Maisonobe
  21.  * @since 10.0
  22.  */
  23. public class SimpleRatioAmbiguityAcceptance implements AmbiguityAcceptance {

  24.     /** Number of candidate solutions. */
  25.     private static final int NB_CANDIDATES = 2;

  26.     /** Acceptance ratio for {@code candidate[0]/candidate[1]}. */
  27.     private final double ratio;

  28.     /** Simple constructor.
  29.      * @param ratio acceptance ratio for {@code candidate[0]/candidate[1]},
  30.      * typically {@code 1.0/2.0} or {@code 1.0/3.0}
  31.      */
  32.     public SimpleRatioAmbiguityAcceptance(final double ratio) {
  33.         this.ratio = ratio;
  34.     }

  35.     /** {@inheritDoc} */
  36.     @Override
  37.     public int numberOfCandidates() {
  38.         return NB_CANDIDATES;
  39.     }

  40.     /** {@inheritDoc}
  41.      * <p>
  42.      * If the ratio {@code candidate[0]/candidate[1]} is smaller or
  43.      * equal to the ratio given at construction, then {@code candidate[0]}
  44.      * will be accepted
  45.      * </p>
  46.      */
  47.     @Override
  48.     public IntegerLeastSquareSolution accept(final IntegerLeastSquareSolution[] candidates) {
  49.         if (candidates[0].getSquaredDistance() / candidates[1].getSquaredDistance() <= ratio) {
  50.             return candidates[0];
  51.         } else {
  52.             return null;
  53.         }
  54.     }

  55. }