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 ()
	~Binning ()
	Binning (const Binning &other)=delete
Binning &	operator= (const Binning &other)=delete
	Binning (Binning &&other)
Binning &	operator= (Binning &&other)
void	SetBinningX (uint8_t value)
	Sets the values of the Binning in horizontal direction. More...
uint8_t	BinningX () const
	Returns the value of the binning in horizontal direction. More...
void	SetBinningY (uint8_t value)
	Sets the values of the Binning in vertical direction. More...
uint8_t	BinningY () const
	Returns the value of the binning in vertical direction. More...
uint8_t	BinningMin () const
	Returns the minimum value for the binning. More...
uint8_t	BinningMax () const
	Returns the maximum value for the binning. More...
Size2D	ExpectedOutputSize (Size2D inputSize, PixelFormatName pixelFormat) const
	Returns the size of a binned image given the input size and pixelformat. More...
void	SetMode (BinningMode mode)
	Sets the values of the Binning mode. More...
BinningMode	Mode () const
	Returns the value of the binning mode. More...
bool	IsPixelFormatSupported (PixelFormatName pixelFormatName) const
	Returns whether the binning supports the given pixel format. More...
Image	Process (const Image &inputImage) const
	Applies the binning on the given image. More...

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
Sum

Constructor & Destructor Documentation

Binning() [1/3]

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

inline

~Binning()

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

inline

Binning() [2/3]

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

delete

Binning() [3/3]

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

inline

Member Function Documentation

BinningMax()

uint8_t peak::ipl::Binning::BinningMax ( ) const

inline

Returns the maximum value for the binning.

Returns

The maximum value for the binning.

Since

1.3.3

BinningMin()

uint8_t peak::ipl::Binning::BinningMin ( ) const

inline

Returns the minimum value for the binning.

Returns

The minimum value for the binning.

Since

1.3.3

BinningX()

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

inline

Returns the value of the binning in horizontal direction.

Returns

The value of the binning in horizontal direction.

Since

1.3.3

BinningY()

uint8_t peak::ipl::Binning::BinningY ( ) const

inline

Returns the value of the binning in vertical direction.

Returns

The value of the binning in vertical direction.

Since

1.3.3

ExpectedOutputSize()

Size2D peak::ipl::Binning::ExpectedOutputSize ( Size2D  inputSize, PixelFormatName  pixelFormat  ) const

inline

Returns the size of a binned image given the input size and pixelformat.

Parameters

[in]	inputSize	The size of the input image.
[in]	pixelFormat	The pixelFormat of the input image.

Returns

The size of a binned image

Exceptions

InvalidArgument

pixelFormat is not supported.

Since

1.3.4

IsPixelFormatSupported()

bool peak::ipl::Binning::IsPixelFormatSupported ( PixelFormatName  pixelFormatName ) const

inline

Returns whether the binning supports the given pixel format.

Returns

Flag whether the given pixel format is supported.

Parameters

[in]

pixelFormatName

The pixel format of interest.

Since

1.3.3

Mode()

Binning::BinningMode peak::ipl::Binning::Mode ( ) const

inline

Returns the value of the binning mode.

Returns

The value of the binning mode.

Since

1.3.3

operator=() [1/2]

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

delete

operator=() [2/2]

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

inline

Process()

Image peak::ipl::Binning::Process ( const Image &  inputImage ) const

inline

Applies the binning on the given image.

Parameters

[in]

inputImage

Image to process.

Returns

A new created image containing the gamma corrected pixels.

Exceptions

ImageFormatNotSupportedException	image has unsupported pixel format.
InvalidArgument	image is too small.

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 is not 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 is not 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 is not supported.

Since

1.3.3

---

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

• peak_ipl/algorithm/peak_ipl_binning.hpp