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.
	~Histogram ()
	Destructor for the Histogram instance.
	Histogram (const Histogram &other)
	Copy Constructor for a new Histogram instance.
Histogram &	operator= (const Histogram &other)
	Copy assigment for Histogram instance.
	Histogram (Histogram &&other) noexcept
	Move constructor for Histogram instance.
Histogram &	operator= (Histogram &&other) noexcept
	Move assignment for Histogram instance.
peak::ipl::PixelFormat	PixelFormat () const
	Returns the pixel format of the histogram.
std::vector< HistogramChannel >	Channels () const
	Returns a vector containing the bin list of each channel.

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.

Note

Will not work with packed pixel formats. See Packed pixel format handling for the correct handling of this.

Exceptions

ImageFormatNotSupportedException

image has a packed pixel format

Since

1.0

1.2 Will throw ImageFormatNotSupportedException if image has a packed pixel format

~Histogram()

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

inline

Destructor for the Histogram instance.

Destroys a Histogram instance.

Since

1.0

Histogram() [3/4]

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

inline

Copy Constructor for a new Histogram instance.

Creates a new Histogram instance.

Note

This only creates a shallow copy. See Shallow copy (since 1.8) for a detailed explanation.

Parameters

[in]

other

The other instance to acquire a reference for.

Since

1.0 Deleted

1.8 Implemented as shallow copy

Histogram() [4/4]

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

inlinenoexcept

Move constructor for Histogram instance.

Moves the instance from other to this. Afterwards other is invalid.

Parameters

[in]

other

The other instance to move.

Since

1.0

Member Function Documentation

Channels()

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

inline

Returns a vector containing the bin list of each channel.

Returns

Channels

Exceptions

Exception

An internal error has occurred.

Since

1.0

operator=() [1/2]

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

inline

Copy assigment for Histogram instance.

Acquires a reference from other to this instance. If this instance already has a reference, it will be destroyed.

Note

See Shallow copy (since 1.8) for a detailed explanation.

Parameters

[in]

other

The other instance to acquire a reference for.

Since

1.0 Deleted

1.8 Implemented as shallow copy

operator=() [2/2]

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

inlinenoexcept

Move assignment for Histogram instance.

Moves the instance from other to this. Afterwards other is invalid.

Parameters

[in]

other

The other instance to move.

Since

1.0

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