DecimationFeature Class Reference

#include <peak_icv/pipeline/features/peak_icv_decimation_feature.hpp>

Inheritance diagram for DecimationFeature:

Public Member Functions
	DecimationFeature (detail::DownsamplingModule &module)
	Creates a DecimationFeature for an existing downsampling module.
void	SetEnabled (bool enabled) override
	Enables or disables the feature.
bool	IsEnabled () const override
	Gets whether this feature is currently enabled.
void	ResetToDefault () override
	Resets all settings to the default values.
void	SetX (uint32_t x)
	Sets the number of columns used for decimation.
void	SetY (uint32_t y)
	Sets the number of rows used for decimation.
uint32_t	GetX () const
	Gets the current number of columns used for decimation.
uint32_t	GetY () const
	Gets the current number of rows used for decimation.
peak::common::IntervalU	GetRange () const
	Gets the valid range for the decimation factors x and y.

Detailed Description

Decimation is used to decrease the image size.

This method reduces resolution by selecting (i.e., skipping) pixels at regular intervals along, columns (x), rows (y) or both. It is computationally efficient but may introduce aliasing.

Note

Processes the entire image, ignoring any specified image region. As with binning, the alpha channel of the input image (if present) is also ignored during decimation. It is always set to the maximum possible pixel value.

Warning

Decimation permanently reduces image resolution. The original resolution cannot be recovered after decimation is applied.

Defaults

• x = 1
• y = 1
• peak::pipeline::detail::DownsamplingMode::Decimation

See also

features::BinningFeature

Since

ids_peak_icv 1.0

Constructor & Destructor Documentation

DecimationFeature()

DecimationFeature ( detail::DownsamplingModule & module )

inlineexplicit

Creates a DecimationFeature for an existing downsampling module.

Parameters

module

Reference to the underlying detail::DownsamplingModule.

Since

ids_peak_icv 1.0

Member Function Documentation

GetRange()

peak::common::IntervalU GetRange ( ) const

inline

Gets the valid range for the decimation factors x and y.

The returned interval specifies the minimum and maximum values that can be passed to SetX or SetY.

Returns

An IntervalU representing the valid decimation factor range.

Since

ids_peak_icv 1.0

GetX()

uint32_t GetX ( ) const

inline

Gets the current number of columns used for decimation.

Returns

The current number of columns used for decimation. The decimation algorithm uses one column, skips the next x - 1 columns, and repeats this process.

Since

ids_peak_icv 1.0

GetY()

uint32_t GetY ( ) const

inline

Gets the current number of rows used for decimation.

Returns

The current number of rows used for decimation. The decimation algorithm uses one row, skips the next y - 1 rows, and repeats this process.

Since

ids_peak_icv 1.0

IsEnabled()

bool IsEnabled ( ) const

inlineoverridevirtual

Gets whether this feature is currently enabled.

Returns

true if enabled; otherwise false.

Since

ids_peak_icv 1.0

Implements IFeature.

ResetToDefault()

void ResetToDefault ( )

inlineoverridevirtual

Resets all settings to the default values.

Note

The enabled state does not change when calling this function.

Since

ids_peak_icv 1.0

Implements IFeature.

SetEnabled()

void SetEnabled ( bool enabled )

inlineoverridevirtual

Enables or disables the feature.

Parameters

enabled

Set to true to enable, or false to disable.

Since

ids_peak_icv 1.0

Implements IFeature.

SetX()

void SetX ( uint32_t x )

inline

Sets the number of columns used for decimation.

Parameters

x	The number of columns used for decimation. The decimation algorithm uses one column, skips the next x - 1 columns, and repeats this process. Valid values are within the range returned by GetRange.

Exceptions

OutOfRangeException

If x is outside the valid range.

Since

ids_peak_icv 1.0

SetY()

void SetY ( uint32_t y )

inline

Sets the number of rows used for decimation.

Parameters

y	The number of rows used for decimation. The decimation algorithm uses one row, skips the next y - 1 rows, and repeats this process. Valid values are within the range returned by GetRange.

Exceptions

OutOfRangeException

If y is outside the valid range.

Since

ids_peak_icv 1.0