robokudo.annotators.cluster_color_histogram
===========================================

.. py:module:: robokudo.annotators.cluster_color_histogram


Classes
-------

.. autoapisummary::

   robokudo.annotators.cluster_color_histogram.ClusterColorHistogramAnnotator


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

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

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


   Calculate the Hue and Saturation Histogram for every Object Hypothesis (cluster) that has a RGB ROI and
   a Mask 


   .. py:class:: Descriptor

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


      .. py:class:: Parameters

         .. py:attribute:: histogram_cols
            :value: 16



         .. py:attribute:: histogram_rows
            :value: 16



         .. py:attribute:: generate_plot_output
            :value: False




      .. py:attribute:: parameters



   .. py:method:: update()

      Called every time the behavior is ticked.



   .. py:method:: create_color_histogram_annotations(color: numpy.typing.NDArray)

      Takes the image of the scene and calculates for each cluster/object hypothesis a 2D Color Histogram. The
      histogram contains the distribution of pixel values over the Hue and Saturation channel.

      :param color: The color image of the scene.
      :return: An image with a plot over all cluster histograms when
      self.descriptor.parameters.generate_plot_output is True . None otherwise.