robokudo.annotators.region_filter
=================================

.. py:module:: robokudo.annotators.region_filter


Classes
-------

.. autoapisummary::

   robokudo.annotators.region_filter.RegionFilter


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

.. py:class:: RegionFilter(name='RegionFilter', descriptor=Descriptor())

   Bases: :py:obj:`robokudo.annotators.core.ThreadedAnnotator`


   The RegionFilter can be used to filter point clouds based on a environment model based on different
   regions. These regions are collected in a 'SemanticMap' which has one 'SemanticMapEntry' per region of interest.
   Semantics to these regions are linked by referencing well-known names from your URDF and/or knowledge base.


   .. py:class:: Descriptor

      Bases: :py:obj:`robokudo.annotators.core.BaseAnnotator.Descriptor`


      .. py:class:: Parameters

         .. py:attribute:: world_frame_name
            :value: 'map'



         .. py:attribute:: semantic_map_ros_package
            :value: 'robokudo'



         .. py:attribute:: semantic_map_name
            :value: 'semantic_map_iai_kitchen'



         .. py:attribute:: active_region
            :value: ''




      .. py:attribute:: parameters



   .. py:attribute:: world_frame_name


   .. py:attribute:: semantic_map
      :value: None



   .. py:attribute:: active_region


   .. py:method:: load_semantic_map() -> None


   .. py:method:: compute()

      This method is doing the heavy lifting of the annotator, if it takes to long to run.