.. index:: pair: class; P1::ImageSdk::Histogram
.. _doxid-class_p1_1_1_image_sdk_1_1_histogram:

class P1::ImageSdk::Histogram
=============================

.. toctree::
	:hidden:

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <P1ImageHistogram.hpp>
	
	class Histogram
	{
	public:
		// construction
	
		:target:`Histogram<doxid-class_p1_1_1_image_sdk_1_1_histogram_1a00ca6440a192e24a1a0be8b24f347970>`();
		:target:`Histogram<doxid-class_p1_1_1_image_sdk_1_1_histogram_1a3240cd7f78991b5c68b3d26099c63cbb>`(:ref:`HistogramType<doxid-namespace_p1_1_1_image_sdk_1ab95bd308db8cda70faa3c31d607f16bb>` type, int binSize, int numChannel);

		// methods
	
		int :ref:`GetBinSize<doxid-class_p1_1_1_image_sdk_1_1_histogram_1a368eb6bc4e9d382ed5316b76c01b253e>`() const;
		:ref:`HistogramType<doxid-namespace_p1_1_1_image_sdk_1ab95bd308db8cda70faa3c31d607f16bb>` :ref:`GetType<doxid-class_p1_1_1_image_sdk_1_1_histogram_1a883c1885814afb16cfc1e681ec9f6162>`() const;
		bool :ref:`IsCumulative<doxid-class_p1_1_1_image_sdk_1_1_histogram_1a55b9982671d1d3722ea31df2bf0f7a49>`() const;
		const int* :ref:`GetChannel<doxid-class_p1_1_1_image_sdk_1_1_histogram_1ab65bdafc69f1ad0e3335b435efb5464b>`(int channel);
		const int :target:`GetNumChannel<doxid-class_p1_1_1_image_sdk_1_1_histogram_1a19cecef1d49064ab39532319f705b155>`() const;
		int* :ref:`GetData<doxid-class_p1_1_1_image_sdk_1_1_histogram_1a3c65aab7690ccbe5cade9c1c0e86dca8>`();
		size_t :ref:`GetDataSizeBytes<doxid-class_p1_1_1_image_sdk_1_1_histogram_1aecb5f9a0c618ec6ac42bcac30ece7dc5>`();
	};
.. _details-class_p1_1_1_image_sdk_1_1_histogram:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Methods
-------

.. index:: pair: function; GetBinSize
.. _doxid-class_p1_1_1_image_sdk_1_1_histogram_1a368eb6bc4e9d382ed5316b76c01b253e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	int GetBinSize() const

:ref:`Histogram <doxid-class_p1_1_1_image_sdk_1_1_histogram>` divides data range to series of intervals. Each interval is a bin.

.. index:: pair: function; GetType
.. _doxid-class_p1_1_1_image_sdk_1_1_histogram_1a883c1885814afb16cfc1e681ec9f6162:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`HistogramType<doxid-namespace_p1_1_1_image_sdk_1ab95bd308db8cda70faa3c31d607f16bb>` GetType() const

Return histogram data type.

.. index:: pair: function; IsCumulative
.. _doxid-class_p1_1_1_image_sdk_1_1_histogram_1a55b9982671d1d3722ea31df2bf0f7a49:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool IsCumulative() const

:ref:`Histogram <doxid-class_p1_1_1_image_sdk_1_1_histogram>` counts value in a bin. Cumulative histogram counts value in a bin plus all smaller value.

.. index:: pair: function; GetChannel
.. _doxid-class_p1_1_1_image_sdk_1_1_histogram_1ab65bdafc69f1ad0e3335b435efb5464b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const int* GetChannel(int channel)

Data type of the channel is defined by HistogramType.

.. index:: pair: function; GetData
.. _doxid-class_p1_1_1_image_sdk_1_1_histogram_1a3c65aab7690ccbe5cade9c1c0e86dca8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	int* GetData()

Array of integer representing histogram data.

.. index:: pair: function; GetDataSizeBytes
.. _doxid-class_p1_1_1_image_sdk_1_1_histogram_1aecb5f9a0c618ec6ac42bcac30ece7dc5:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	size_t GetDataSizeBytes()

:ref:`Size <doxid-struct_p1_1_1_image_sdk_1_1_size>` in bytes of the histogram data.