peak::ipl::Histogram Class Reference

Stores the histogram values. More...

#include <peak_ipl/algorithm/peak_ipl_histogram.hpp>

Classes
struct	HistogramChannel
	Stores the values of the histogram. More...

Public Member Functions
	Histogram ()=delete
	Histogram (const Image &image)
	Constructor. More...
	~Histogram ()
	Histogram (const Histogram &other)=delete
Histogram &	operator= (const Histogram &other)=delete
	Histogram (Histogram &&other)
Histogram &	operator= (Histogram &&other)
peak::ipl::PixelFormat	PixelFormat () const
	Returns the pixel format of the histogram. More...
std::vector< HistogramChannel >	Channels () const
	Returns a vector containing the bin list of each channel. More...

Detailed Description

Stores the histogram values.

Constructor & Destructor Documentation

Histogram() [1/4]

peak::ipl::Histogram::Histogram ( )

delete

Histogram() [2/4]

peak::ipl::Histogram::Histogram ( const Image &  image )

inlineexplicit

Constructor.

Parameters

[in]

image

Image to process.

Exceptions

ImageFormatNotSupportedException

image has packed pixel format

Since

1.0

1.2 Will throw ImageFormatNotSupportedException if image has packed pixel format

~Histogram()

peak::ipl::Histogram::~Histogram ( )

inline

Histogram() [3/4]

peak::ipl::Histogram::Histogram ( const Histogram &  other )

delete

Histogram() [4/4]

peak::ipl::Histogram::Histogram ( Histogram &&  other )

inline

Member Function Documentation

Channels()

std::vector< Histogram::HistogramChannel > peak::ipl::Histogram::Channels ( ) const

inline

Returns a vector containing the bin list of each channel.

For more details on how to apply the two-step procedure this function requires, see also PEAK_IPL_GetLastError().

Returns

Channels

Exceptions

Exception

An internal error has occurred.

Since

1.0

operator=() [1/2]

Histogram& peak::ipl::Histogram::operator= ( const Histogram &  other )

delete

operator=() [2/2]

Histogram & peak::ipl::Histogram::operator= ( Histogram &&  other )

inline

PixelFormat()

peak::ipl::PixelFormat peak::ipl::Histogram::PixelFormat ( ) const

inline

Returns the pixel format of the histogram.

Returns

PixelFormat

Exceptions

Exception

An internal error has occurred.

Since

1.0

---

The documentation for this class was generated from the following file:

• peak_ipl/algorithm/peak_ipl_histogram.hpp