linear_motion_model.hpp

Go to the documentation of this file.

// Copyright 2021 the Autoware Foundation
//
// Licensed 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.
//
// Developed by Apex.AI, Inc.


#ifndef MOTION_MODEL__LINEAR_MOTION_MODEL_HPP_
#define MOTION_MODEL__LINEAR_MOTION_MODEL_HPP_

#include <kalman_filter/common_states.hpp>
#include <kalman_filter/generic_state.hpp>
#include <kalman_filter/visibility_control.hpp>
#include <motion_model/motion_model_interface.hpp>

namespace autoware
{
namespace prediction
{

template<typename StateT>
class KALMAN_FILTER_PUBLIC LinearMotionModel
  : public MotionModelInterface<LinearMotionModel<StateT>>
{
public:
  using State = StateT;

protected:
  // Allow the CRTP interface to call private functions.
  friend MotionModelInterface<LinearMotionModel<StateT>>;

  inline State crtp_predict(
    const State & state,
    const std::chrono::nanoseconds & dt) const
  {
    return State{crtp_jacobian(state, dt) * state.vector()};
  }

  typename State::Matrix crtp_jacobian(const State &, const std::chrono::nanoseconds &) const
  {
    static_assert(
      sizeof(StateT) == 0U,
      "\n\nThis function must be specialized for specific states.\n\n");
  }
};


template<>
KALMAN_FILTER_PUBLIC state::ConstAccelerationXYYaw::Matrix
LinearMotionModel<state::ConstAccelerationXYYaw>::crtp_jacobian(
  const State & state, const std::chrono::nanoseconds & dt) const;

template<>
KALMAN_FILTER_PUBLIC state::ConstAccelerationXY::Matrix
LinearMotionModel<state::ConstAccelerationXY>::crtp_jacobian(
  const State & state, const std::chrono::nanoseconds & dt) const;

}  // namespace prediction
}  // namespace autoware

#endif  // MOTION_MODEL__LINEAR_MOTION_MODEL_HPP_