robokudo.types.belief_state
===========================

.. py:module:: robokudo.types.belief_state


Classes
-------

.. autoapisummary::

   robokudo.types.belief_state.ObjectBeliefState


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

.. py:class:: ObjectBeliefState

   .. py:attribute:: body
      :type:  semantic_digital_twin.world_description.world_entity.Body

      The semdt body associated with the belief state.



   .. py:attribute:: max_num_hypotheses
      :type:  int
      :value: 1


      The maximum number of object hypotheses to keep in the belief state.



   .. py:attribute:: hypotheses
      :type:  typing_extensions.Deque[robokudo.types.scene.ObjectHypothesis]

      The hypotheses associated with the belief state.



   .. py:method:: __post_init__()


   .. py:method:: create_with_new_body(name: typing_extensions.Optional[semantic_digital_twin.datastructures.prefixed_name.PrefixedName] = None) -> typing_extensions.Self
      :classmethod:


      Create a new ObjectBeliefState with a new Body.

      :param name: Name of the body.
      :return: The new object belief state.



   .. py:property:: uuid
      :type: uuid.UUID


      The UUID of the belief state.



   .. py:property:: latest_hypothesis
      :type: typing_extensions.Optional[robokudo.types.scene.ObjectHypothesis]


      The latest hypothesis added to the belief state.



   .. py:property:: latest_pose
      :type: typing_extensions.Optional[robokudo.types.annotation.PoseAnnotation]


      The newest pose annotation of the latest hypothesis.



   .. py:property:: latest_bbox_3d
      :type: typing_extensions.Optional[robokudo.types.annotation.BoundingBox3DAnnotation]


      The newest 3D bounding box annotation of the latest hypothesis.



   .. py:method:: add_hypothesis(hypothesis: robokudo.types.scene.ObjectHypothesis) -> typing_extensions.Self

      Add a new hypothesis to the belief state.

      :param hypothesis: The hypothesis to add.