peak::ipl::Decimation Class Reference

#include <peak_ipl/algorithm/peak_ipl_decimation.hpp>

Public Member Functions
	Decimation ()
	Constructor for a new Decimation instance. More...
	~Decimation ()
	Destructor for the Decimation instance. More...
	Decimation (const Decimation &other)
	Copy Constructor for a new Decimation instance. More...
Decimation &	operator= (const Decimation &other)
	Copy assigment for Decimation instance. More...
	Decimation (Decimation &&other) noexcept
	Move constructor for Decimation instance. More...
Decimation &	operator= (Decimation &&other) noexcept
	Move assignment for Decimation instance. More...
void	SetDecimationX (uint8_t value)
	Sets the values of the decimation in horizontal direction. More...
void	SetDecimationY (uint8_t value)
	Sets the values of the decimation in vertical direction. More...

Public Attributes
	PEAK_IPL_MAYBE_UNUSED = uint8_t DecimationX() const

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

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

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

Member Data Documentation

PEAK_IPL_MAYBE_UNUSED

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

---

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

• peak_ipl/algorithm/peak_ipl_decimation.hpp