peak::ipl::Binning Class Reference

#include <peak_ipl/algorithm/peak_ipl_binning.hpp>

Public Types
enum	BinningMode : uint16_t {   BinningMode::Average = 0,   BinningMode::Sum = 1 }
	Mode parameter for the binning algorithm. More...

Public Member Functions
	Binning ()
	Constructor for a new Binning instance. More...
	~Binning ()
	Destructor for the Binning instance. More...
	Binning (const Binning &other)
	Copy Constructor for a new Binning instance. More...
Binning &	operator= (const Binning &other)
	Copy assigment for Binning instance. More...
	Binning (Binning &&other) noexcept
	Move constructor for Binning instance. More...
Binning &	operator= (Binning &&other) noexcept
	Move assignment for Binning instance. More...
void	SetBinningX (uint8_t value)
	Sets the values of the binning in horizontal direction. More...
void	SetBinningY (uint8_t value)
	Sets the values of the binning in vertical direction. More...
void	SetMode (BinningMode mode)
	Sets the values of the binning mode. More...

Public Attributes
	PEAK_IPL_MAYBE_UNUSED = uint8_t BinningX() const

Member Enumeration Documentation

BinningMode

enum peak::ipl::Binning::BinningMode : uint16_t

strong

Mode parameter for the binning algorithm.

The enum holding the possible modi.

Enumerator
Average	Average (mean) of pixels.
Sum	Sum of pixels.

Constructor & Destructor Documentation

Binning() [1/3]

peak::ipl::Binning::Binning ( )

inline

Constructor for a new Binning instance.

Creates a new Binning instance.

Since

1.3.3

~Binning()

peak::ipl::Binning::~Binning ( )

inline

Destructor for the Binning instance.

Destroys a Binning instance.

Since

1.3.3

Binning() [2/3]

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

inline

Copy Constructor for a new Binning instance.

Creates a new Binning 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.3.3 Deleted

1.8 Implemented as shallow copy

Binning() [3/3]

peak::ipl::Binning::Binning ( Binning &&  other )

inlinenoexcept

Move constructor for Binning instance.

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

Parameters

[in]

other

The other instance to move.

Since

1.3.3

Member Function Documentation

operator=() [1/2]

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

inline

Copy assigment for Binning 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.3.3 Deleted

1.8 Implemented as shallow copy

operator=() [2/2]

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

inlinenoexcept

Move assignment for Binning instance.

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

Parameters

[in]

other

The other instance to move.

Since

1.3.3

SetBinningX()

void peak::ipl::Binning::SetBinningX ( uint8_t  value )

inline

Sets the values of the binning in horizontal direction.

Parameters

[in]

value

The value of the binning in horizontal direction.

Exceptions

InvalidArgument

value isn't supported.

Since

1.3.3

SetBinningY()

void peak::ipl::Binning::SetBinningY ( uint8_t  value )

inline

Sets the values of the binning in vertical direction.

Parameters

[in]

value

The value of the binning in vertical direction.

Exceptions

InvalidArgument

value isn't supported.

Since

1.3.3

SetMode()

void peak::ipl::Binning::SetMode ( Binning::BinningMode  mode )

inline

Sets the values of the binning mode.

Parameters

[in]

mode

The value of the binning mode.

Exceptions

InvalidArgument

value isn't supported.

Since

1.3.3

Member Data Documentation

PEAK_IPL_MAYBE_UNUSED

peak::ipl::Binning::PEAK_IPL_MAYBE_UNUSED = uint8_t BinningX() const

---

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

• peak_ipl/algorithm/peak_ipl_binning.hpp