BinningFeature Class Reference

Inheritance diagram for BinningFeature:

Public Member Functions
	BinningFeature (DownsamplingModule module)
	Creates a BinningFeature for a downsampling module.
void	ResetToDefault ()
	Resets the binning feature to the default values.

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

Detailed Description

Binning is used to decrease the image size.

This method reduces resolution by summarizing or averaging groups of pixels in the horizontal (X) and/or vertical (Y) directions. It helps preserve image quality by minimizing aliasing artifacts.

Note

Processes the entire image, ignoring any specified image region.

Note

The alpha channel of the input image (if present) is also ignored. This is because the alpha channel can have different interpretations — such as transparency, segmentation labels, or masks — each of which would require different handling during binning. Consequently, the alpha channel of the output image is always set to the maximum possible pixel value.

Warning

Binning permanently reduces image resolution. The original resolution cannot be recovered after binning is applied.

Defaults

• x = 1
• y = 1
• BinningMode.Average

Since

IDSImaging.Peak.ICV 1.3

Definition at line 43 of file BinningFeature.cs.

Constructor & Destructor Documentation

BinningFeature()

BinningFeature ( DownsamplingModule module )

inline

Creates a BinningFeature for a downsampling module.

Parameters

module

Reference to the underlying DownsamplingModule.

Definition at line 53 of file BinningFeature.cs.

Member Function Documentation

ResetToDefault()

void ResetToDefault ( )

inline

Resets the binning feature to the default values.

Note

The enabled state does not change when calling this function.

Implements IFeature.

Definition at line 116 of file BinningFeature.cs.

Property Documentation

IsEnabled

bool IsEnabled

getset

Enables or disables the feature.

Implements IFeature.

Definition at line 103 of file BinningFeature.cs.

Mode

BinningMode Mode

getset

The current BinningMode.

Definition at line 88 of file BinningFeature.cs.

Range

IntervalU Range

get

Gets the valid range for the binning factors X and Y.

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

Definition at line 83 of file BinningFeature.cs.

X

uint X

getset

The current number of columns used for binning.

Definition at line 61 of file BinningFeature.cs.

Y

uint Y

getset

The current number of rows used for binning.

Definition at line 70 of file BinningFeature.cs.