:orphan:

:mod:`torchfilter.filters._virtual_sensor_filters`
==================================================

.. py:module:: torchfilter.filters._virtual_sensor_filters

.. autoapi-nested-parse::

   Private module; avoid importing from directly.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   torchfilter.filters._virtual_sensor_filters.VirtualSensorExtendedInformationFilter
   torchfilter.filters._virtual_sensor_filters.VirtualSensorExtendedKalmanFilter
   torchfilter.filters._virtual_sensor_filters.VirtualSensorUnscentedKalmanFilter
   torchfilter.filters._virtual_sensor_filters.VirtualSensorSquareRootUnscentedKalmanFilter



.. py:class:: VirtualSensorExtendedInformationFilter(*, dynamics_model: DynamicsModel, virtual_sensor_model: VirtualSensorModel)

   Bases: :class:`torchfilter.filters`, :class:`torchfilter.filters.ExtendedInformationFilter`

   .. autoapi-inheritance-diagram:: torchfilter.filters._virtual_sensor_filters.VirtualSensorExtendedInformationFilter
      :parts: 1

   EIF variant with a virtual sensor model.

   Assumes measurement model is identity.


.. py:class:: VirtualSensorExtendedKalmanFilter(*, dynamics_model: DynamicsModel, virtual_sensor_model: VirtualSensorModel)

   Bases: :class:`torchfilter.filters`, :class:`torchfilter.filters.ExtendedKalmanFilter`

   .. autoapi-inheritance-diagram:: torchfilter.filters._virtual_sensor_filters.VirtualSensorExtendedKalmanFilter
      :parts: 1

   EKF variant with a virtual sensor model.

   Assumes measurement model is identity.


.. py:class:: VirtualSensorUnscentedKalmanFilter(*, dynamics_model: DynamicsModel, virtual_sensor_model: VirtualSensorModel, sigma_point_strategy: Optional[utils.SigmaPointStrategy] = None)

   Bases: :class:`torchfilter.filters`, :class:`torchfilter.filters.UnscentedKalmanFilter`

   .. autoapi-inheritance-diagram:: torchfilter.filters._virtual_sensor_filters.VirtualSensorUnscentedKalmanFilter
      :parts: 1

   UKF variant with a virtual sensor model.

   Assumes measurement model is identity.


.. py:class:: VirtualSensorSquareRootUnscentedKalmanFilter(*, dynamics_model: DynamicsModel, virtual_sensor_model: VirtualSensorModel, sigma_point_strategy: Optional[utils.SigmaPointStrategy] = None)

   Bases: :class:`torchfilter.filters`, :class:`torchfilter.filters.SquareRootUnscentedKalmanFilter`

   .. autoapi-inheritance-diagram:: torchfilter.filters._virtual_sensor_filters.VirtualSensorSquareRootUnscentedKalmanFilter
      :parts: 1

   Square-root UKF variant with a virtual sensor model.

   Assumes measurement model is identity.