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.time.AbsoluteDate;
26  import org.orekit.utils.ParameterDriver;
27  
28  /** Interface for lines-of-sight transforms.
29   * @author Luc Maisonobe
30   * @see LOSBuilder
31   */
32  public interface LOSTransform {
33  
34      /** Transform a line-of-sight.
35       * @param i los pixel index
36       * @param los line-of-sight to transform
37       * @param date current date
38       * @return transformed line-of-sight
39       */
40      Vector3D transformLOS(int i, Vector3D los, AbsoluteDate date);
41  
42      /** Transform a line-of-sight and its partial derivatives.
43       * <p>
44       * This method is used for LOS calibration purposes. It allows to compute
45       * the Jacobian matrix of the LOS with respect to the parameters, which
46       * are typically polynomials coefficients representing rotation angles.
47       * These polynomials can be used for example to model thermo-elastic effects.
48       * </p>
49       * @param index los pixel index
50       * @param los line-of-sight to transform
51       * @param date date
52       * @param generator generator to use for building {@link DerivativeStructure} instances
53       * @return line of sight, and its first partial derivatives with respect to the parameters
54       */
55      FieldVector3D<DerivativeStructure> transformLOS(int index, FieldVector3D<DerivativeStructure> los,
56                                                      AbsoluteDate date, DSGenerator generator);
57  
58      /** Get the drivers for LOS parameters.
59       * @return drivers for LOS parameters
60       * @since 2.0
61       */
62      Stream<ParameterDriver> getParametersDrivers();
63  
64  }