1 /*
2 * Copyright (C) 2021 Alberto Irurueta Carro (alberto@irurueta.com)
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package com.irurueta.navigation.inertial.calibration.magnetometer;
17
18 import com.irurueta.navigation.LockedException;
19 import com.irurueta.navigation.inertial.calibration.StandardDeviationBodyMagneticFluxDensity;
20
21 import java.util.List;
22
23 /**
24 * Defines a magnetometer calibrator using ordered lists of
25 * {@link StandardDeviationBodyMagneticFluxDensity} measurements.
26 */
27 public interface OrderedStandardDeviationBodyMagneticFluxDensityMagnetometerCalibrator extends MagnetometerCalibrator {
28
29 /**
30 * Gets collection of body magnetic flux density measurements taken
31 * at a given position with different unknown orientations and containing the
32 * standard deviation of magnetometer measurements.
33 *
34 * @return collection of body magnetic flux density measurements at
35 * a known position and timestamp with unknown orientations.
36 */
37 List<StandardDeviationBodyMagneticFluxDensity> getMeasurements();
38
39 /**
40 * Sets collection of body magnetic flux density measurements taken
41 * at a given position with different unknown orientations and containing the
42 * standard deviation of magnetometer measurements.
43 *
44 * @param measurements collection of body magnetic flux density
45 * measurements at a known position and timestamp
46 * with unknown orientations.
47 * @throws LockedException if calibrator is currently running.
48 */
49 void setMeasurements(final List<StandardDeviationBodyMagneticFluxDensity> measurements) throws LockedException;
50 }