DecimationFeature Class Reference

Inheritance diagram for DecimationFeature:

Public Member Functions
	DecimationFeature (DownsamplingModule module)
	Creates a DecimationFeature for a downsampling module.
void	ResetToDefault ()
	Resets all settings to the default values.

Properties
uint	X [get, set]
	The current number of columns used for decimation.
uint	Y [get, set]
	The current number of rows used for decimation.
IntervalU	Range [get]
	Gets the valid range for the decimation factors X and Y.
bool	IsEnabled [get, set]
	Enables or disables the feature.

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.

Note

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

Since

IDSImaging.Peak.ICV 1.3

Definition at line 39 of file DecimationFeature.cs.

Constructor & Destructor Documentation

DecimationFeature()

DecimationFeature ( DownsamplingModule module )

inline

Creates a DecimationFeature for a downsampling module.

Parameters

module

Reference to the underlying DownsamplingModule.

Definition at line 49 of file DecimationFeature.cs.

Member Function Documentation

ResetToDefault()

void ResetToDefault ( )

inline

Resets all settings to the default values.

Note

The enabled state does not change when calling this function.

Implements IFeature.

Definition at line 95 of file DecimationFeature.cs.

Property Documentation

IsEnabled

bool IsEnabled

getset

Enables or disables the feature.

Implements IFeature.

Definition at line 82 of file DecimationFeature.cs.

Range

IntervalU Range

get

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 X or Y.

Definition at line 79 of file DecimationFeature.cs.

X

uint X

getset

The current number of columns used for decimation.

Definition at line 57 of file DecimationFeature.cs.

Y

uint Y

getset

The current number of rows used for decimation.

Definition at line 66 of file DecimationFeature.cs.