robokudo.utils.comparators
==========================

.. py:module:: robokudo.utils.comparators


Classes
-------

.. autoapisummary::

   robokudo.utils.comparators.FeatureComparator
   robokudo.utils.comparators.TranslationComparator
   robokudo.utils.comparators.BboxComparator
   robokudo.utils.comparators.SizeComparator
   robokudo.utils.comparators.ClassnameComparator
   robokudo.utils.comparators.HistogramComparator
   robokudo.utils.comparators.SemanticColorComparator
   robokudo.utils.comparators.AdditionalDataComparator
   robokudo.utils.comparators.RoiComparator


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

.. py:class:: FeatureComparator(weight: float)

   .. py:attribute:: weight


   .. py:method:: compute_similarity(query_value, obj_value) -> float
      :abstractmethod:



.. py:class:: TranslationComparator(weight: float, max_distance: float)

   Bases: :py:obj:`FeatureComparator`


   .. py:attribute:: max_distance


   .. py:method:: compute_similarity(query_value, obj_value) -> float


.. py:class:: BboxComparator(weight: float)

   Bases: :py:obj:`FeatureComparator`


   .. py:method:: compute_similarity(query_value: robokudo.types.annotation.BoundingBox3DAnnotation, obj_value: robokudo.types.annotation.BoundingBox3DAnnotation) -> float


.. py:class:: SizeComparator(weight: float)

   Bases: :py:obj:`FeatureComparator`


   .. py:method:: compute_similarity(query_value: list, obj_value: list) -> float


.. py:class:: ClassnameComparator(weight: float)

   Bases: :py:obj:`FeatureComparator`


   .. py:method:: compute_similarity(query_value: robokudo.types.annotation.Classification, obj_value: robokudo.types.annotation.Classification) -> float


.. py:class:: HistogramComparator(weight: float)

   Bases: :py:obj:`FeatureComparator`


   .. py:method:: compute_similarity(query_value: robokudo.types.annotation.ColorHistogram, obj_value: robokudo.types.annotation.ColorHistogram) -> float


.. py:class:: SemanticColorComparator(weight: float)

   Bases: :py:obj:`FeatureComparator`


   .. py:method:: compute_similarity(query_value: robokudo.types.annotation.SemanticColor, obj_value: robokudo.types.annotation.SemanticColor) -> float


.. py:class:: AdditionalDataComparator(weight: float)

   Bases: :py:obj:`FeatureComparator`


   .. py:method:: compute_similarity(query_value, obj_value) -> float


.. py:class:: RoiComparator(weight: float)

   Bases: :py:obj:`FeatureComparator`


   .. py:method:: compute_similarity(query_value: robokudo.types.cv.Rect, obj_value: robokudo.types.cv.Rect) -> float

      Computes the similarity of two Region of Interests by calculating their area overlap and returning it as a percentage.