/* Copyright 2002-2024 Bryan Cazabonne
    * Licensed to CS GROUP (CS) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * Bryan Cazabonne licenses this file to You under the Apache License, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License.  You may obtain a copy of the License at
    *
    *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.orekit.estimation.measurements.generation;
  
  import java.util.Map;
  
  import org.hipparchus.random.CorrelatedRandomVectorGenerator;
  import org.orekit.estimation.measurements.EstimationModifier;
  import org.orekit.estimation.measurements.FDOA;
  import org.orekit.estimation.measurements.GroundStation;
  import org.orekit.estimation.measurements.ObservableSatellite;
  import org.orekit.propagation.SpacecraftState;
  import org.orekit.propagation.sampling.OrekitStepInterpolator;
  import org.orekit.time.AbsoluteDate;
  import org.orekit.utils.ParameterDriver;
  
  /** Builder for {@link FDOA} measurements.
   * @author Bryan Cazabonne
   * @since 12.0
   */
  public class FDOABuilder extends AbstractMeasurementBuilder<FDOA> {
  
      /** Prime ground station. */
      private final GroundStation primeStation;
  
      /** Second ground station. */
      private final GroundStation secondStation;
  
      /** Centre frequency of the signal emitted from the satellite. */
      private final double centreFrequency;
  
      /** Satellite related to this builder. */
      private final ObservableSatellite satellite;
  
      /** Simple constructor.
       * @param noiseSource noise source, may be null for generating perfect measurements
       * @param primeStation ground station that gives the date of the measurement
       * @param secondStation ground station that gives the measurement
       * @param centreFrequency satellite emitter frequency
       * @param sigma theoretical standard deviation
       * @param baseWeight base weight
       * @param satellite satellite related to this builder
       */
      public FDOABuilder(final CorrelatedRandomVectorGenerator noiseSource,
                         final GroundStation primeStation,
                         final GroundStation secondStation,
                         final double centreFrequency,
                         final double sigma, final double baseWeight,
                         final ObservableSatellite satellite) {
          super(noiseSource, sigma, baseWeight, satellite);
          this.primeStation    = primeStation;
          this.secondStation   = secondStation;
          this.centreFrequency = centreFrequency;
          this.satellite       = satellite;
      }
  
      /** {@inheritDoc} */
      @Override
      public FDOA build(final AbsoluteDate date, final Map<ObservableSatellite, OrekitStepInterpolator> interpolators) {
  
          final double sigma                  = getTheoreticalStandardDeviation()[0];
          final double baseWeight             = getBaseWeight()[0];
          final SpacecraftState[] relevant    = new SpacecraftState[] { interpolators.get(satellite).getInterpolatedState(date) };
  
          // create a dummy measurement
          final FDOA dummy = new FDOA(primeStation, secondStation, centreFrequency, relevant[0].getDate(),
                                      Double.NaN, sigma, baseWeight, satellite);
          for (final EstimationModifier<FDOA> modifier : getModifiers()) {
              dummy.addModifier(modifier);
          }
  
          // set a reference date for parameters missing one
          for (final ParameterDriver driver : dummy.getParametersDrivers()) {
              if (driver.getReferenceDate() == null) {
                  final AbsoluteDate start = getStart();
                  final AbsoluteDate end   = getEnd();
                  driver.setReferenceDate(start.durationFrom(end) <= 0 ? start : end);
              }
          }
  
          // estimate the perfect value of the measurement
          double fdoa = dummy.estimateWithoutDerivatives(relevant).getEstimatedValue()[0];
  
          // add the noise
          final double[] noise = getNoise();
         if (noise != null) {
             fdoa += noise[0];
         }
 
         // generate measurement
         final FDOA measurement = new FDOA(primeStation, secondStation, centreFrequency, relevant[0].getDate(),
                                           fdoa, sigma, baseWeight, satellite);
         for (final EstimationModifier<FDOA> modifier : getModifiers()) {
             measurement.addModifier(modifier);
         }
         return measurement;
 
     }
 
 }