1   /* Copyright 2013-2019 CS Systèmes d'Information
2    * Licensed to CS Systèmes d'Information (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.rugged.los;
18  
19  import java.util.stream.Stream;
20  
21  import org.hipparchus.analysis.differentiation.DerivativeStructure;
22  import org.hipparchus.geometry.euclidean.threed.FieldVector3D;
23  import org.hipparchus.geometry.euclidean.threed.Vector3D;
24  import org.orekit.rugged.utils.DSGenerator;
25  import org.orekit.utils.ParameterDriver;
26  
27  /** Interface for lines-of-sight tranforms that do not depend on time.
28   * @author Luc Maisonobe
29   * @see LOSBuilder
30   */
31  public interface TimeIndependentLOSTransform {
32  
33      /** Transform a line-of-sight.
34       * @param i los pixel index
35       * @param los line-of-sight to transform
36       * @return transformed line-of-sight
37       */
38      Vector3D transformLOS(int i, Vector3D los);
39  
40      /** Transform a line-of-sight and its partial derivatives.
41       * <p>
42       * This method is used for LOS calibration purposes. It allows to compute
43       * the Jacobian matrix of the LOS with respect to the parameters, which
44       * are typically polynomials coefficients representing rotation angles.
45       * These polynomials can be used for example to model thermo-elastic effects.
46       * </p>
47       * <p>
48       * Note that in order for the partial derivatives to be properly set up, the
49       * {@link org.orekit.utils.ParameterDriver#setSelected(boolean) setSelected}
50       * method must have been set to {@code true} for the various parameters returned
51       * by {@link #getParametersDrivers()} that should be estimated.
52       * </p>
53       * @param index los pixel index
54       * @param los line-of-sight to transform
55       * @param generator generator to use for building {@link DerivativeStructure} instances
56       * @return line of sight, and its first partial derivatives with respect to the parameters
57       */
58      FieldVector3D<DerivativeStructure> transformLOS(int index, FieldVector3D<DerivativeStructure> los,
59                                                      DSGenerator generator);
60  
61      /** Get the drivers for LOS parameters.
62       * @return drivers for LOS parameters
63       * @since 2.0
64       */
65      Stream<ParameterDriver> getParametersDrivers();
66  
67  }