1 /*
2 * Licensed to the Hipparchus project under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The Hipparchus project 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 * https://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.hipparchus.filtering.kalman;
18
19 /** Observer for Kalman filter recursions.
20 * <p>
21 * This interface is intended to be implemented by users to monitor
22 * the progress of the Kalman filter estimator during estimation.
23 * </p>
24 */
25 public interface KalmanObserver {
26
27 /** Callback for initialisation of observer.
28 * @param estimate estimate calculated by a Kalman filter
29 */
30 default void init(KalmanEstimate estimate) {}
31
32 /** Notification callback after each Kalman filter measurement update.
33 * @param estimate estimate calculated by a Kalman filter
34 */
35 void updatePerformed(KalmanEstimate estimate);
36 }