#include <peak_ipl/algorithm/peak_ipl_decimation.hpp>

Public Member Functions
	Decimation ()
	Constructor for a new Decimation instance.

	~Decimation ()
	Destructor for the Decimation instance.

	Decimation (const Decimation &other)
	Copy Constructor for a new Decimation instance.

Decimation &	operator= (const Decimation &other)
	Copy assigment for Decimation instance.

	Decimation (Decimation &&other) noexcept
	Move constructor for Decimation instance.

Decimation &	operator= (Decimation &&other) noexcept
	Move assignment for Decimation instance.

void	SetDecimationX (uint8_t value)
	Sets the values of the decimation in horizontal direction.

uint8_t	DecimationX () const
	Returns the value of the decimation in horizontal direction.

void	SetDecimationY (uint8_t value)
	Sets the values of the decimation in vertical direction.

uint8_t	DecimationY () const
	Returns the value of the decimation in vertical direction.

uint8_t	DecimationMin () const
	Returns the minimum value for the decimation.

uint8_t	DecimationMax () const
	Returns the maximum value for the decimation.

Size2D	ExpectedOutputSize (Size2D inputSize, PixelFormatName pixelFormat) const
	Returns the size of a decimated image given the input size and pixelformat.

bool	IsPixelFormatSupported (PixelFormatName pixelFormatName) const
	Returns whether the decimation supports the given pixel format.

Image	Process (const Image &inputImage) const
	Applies the decimation on the given image.

Constructor & Destructor Documentation

◆ Decimation() [1/3]

peak::ipl::Decimation::Decimation ( )

inline

Constructor for a new Decimation instance.

Creates a new Decimation instance.

Since: 1.6.0

◆ ~Decimation()

peak::ipl::Decimation::~Decimation ( )

inline

Destructor for the Decimation instance.

Destroys a Decimation instance.

Since: 1.6.0

◆ Decimation() [2/3]

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

inline

Copy Constructor for a new Decimation instance.

Creates a new Decimation 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.6.0 Deleted; 1.8 Implemented as shallow copy

◆ Decimation() [3/3]

peak::ipl::Decimation::Decimation ( Decimation && other )

inlinenoexcept

Move constructor for Decimation instance.

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

Parameters

[in] other The other instance to move.

Since: 1.6.0

Member Function Documentation

◆ DecimationMax()

uint8_t peak::ipl::Decimation::DecimationMax ( ) const

inline

Returns the maximum value for the decimation.

Returns: The maximum value for the decimation.

Since: 1.6.0

◆ DecimationMin()

uint8_t peak::ipl::Decimation::DecimationMin ( ) const

inline

Returns the minimum value for the decimation.

Returns: The minimum value for the decimation.

Since: 1.6.0

◆ DecimationX()

uint8_t peak::ipl::Decimation::DecimationX ( ) const

inline

Returns the value of the decimation in horizontal direction.

Returns: The value of the decimation in horizontal direction.

Since: 1.6.0

◆ DecimationY()

uint8_t peak::ipl::Decimation::DecimationY ( ) const

inline

Returns the value of the decimation in vertical direction.

Returns: The value of the decimation in vertical direction.

Since: 1.6.0

◆ ExpectedOutputSize()

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

inline

Returns the size of a decimated 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 decimated image

Exceptions

InvalidArgument pixelFormat isn't supported.

Since: 1.6.0

◆ IsPixelFormatSupported()

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

inline

Returns whether the decimation supports the given pixel format.

Returns: Flag whether the given pixel format is supported.

Parameters

[in] pixelFormatName The pixel format of interest.

Since: 1.6.0

◆ operator=() [1/2]

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

inline

Copy assigment for Decimation 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.6.0 Deleted; 1.8 Implemented as shallow copy

◆ operator=() [2/2]

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

inlinenoexcept

Move assignment for Decimation instance.

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

Parameters

[in] other The other instance to move.

Since: 1.6.0

◆ Process()

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

inline

Applies the decimation on the given image.

Parameters

[in] inputImage Image to process.

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

Returns: A new created image containing the decimated pixels.

Exceptions

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

Since: 1.6.0

◆ SetDecimationX()

void peak::ipl::Decimation::SetDecimationX ( uint8_t value )

inline

Sets the values of the decimation in horizontal direction.

Parameters

[in] value The value of the decimation in horizontal direction.

Exceptions

InvalidArgument value isn't supported.

Since: 1.6.0

◆ SetDecimationY()

void peak::ipl::Decimation::SetDecimationY ( uint8_t value )

inline

Sets the values of the decimation in vertical direction.

Parameters

[in] value The value of the decimation in vertical direction.

Exceptions

InvalidArgument value isn't supported.

Since: 1.6.0

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

peak_ipl/algorithm/peak_ipl_decimation.hpp

Public Member Functions

Constructor & Destructor Documentation

◆ Decimation() [1/3]

◆ ~Decimation()

◆ Decimation() [2/3]

◆ Decimation() [3/3]

Member Function Documentation

◆ DecimationMax()

◆ DecimationMin()

◆ DecimationX()

◆ DecimationY()

◆ ExpectedOutputSize()

◆ IsPixelFormatSupported()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Process()

◆ SetDecimationX()

◆ SetDecimationY()