DecimationFeature Class Reference

Inheritance diagram for DecimationFeature:

Public Member Functions
None	__init__ (self, DownsamplingModule module)
	Creates a DecimationFeature for an existing downsampling module.
bool	enabled (self)
	Gets whether this feature is currently enabled.
None	enabled (self, bool enabled)
	Enables or disables the feature.
None	reset_to_default (self)
	Resets all settings to their defaults.
int	x (self)
	Gets the current number of columns used for decimation.
None	x (self, int value)
	Sets the number of columns used for decimation.
int	y (self)
	Gets the current number of rows used for decimation.
None	y (self, int value)
	Sets the number of rows used for decimation.
Interval	range (self)
	Gets the valid range for the decimation factors x and y.

Protected Attributes
	_module = module

Detailed Description

Decimation is used to decrease the image size.

Supported pixel formats

BayerGR8 BayerGR10 BayerGR12 BayerRG8 BayerRG10 BayerRG12 BayerGB8 BayerGB10 BayerGB12 BayerBG8

BayerBG10 BayerBG12 Mono8 Mono10 Mono12 Mono16 Confidence8 Confidence16 Coord3D_C8 Coord3D_C16

Coord3D_C32f Coord3D_ABC32f RGB8 RGB10 RGB12 BGR8 BGR10 BGR12 RGBa8 RGBa10

RGBa12 BGRa8 BGRa10 BGRa12 Mono32fIDS RGB32fIDS Mono32f RGB32f

See the Pixel and Pixel Format Specifications for a detailed description of the pixel formats.

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.

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

Default Configuration:

• x = 1
• y = 1
• DownsamplingMode.Decimation

Since

ids_peak_icv 1.0

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		DownsamplingModule	module )

Creates a DecimationFeature for an existing downsampling module.

Parameters

module

module Reference to the underlying DownsamplingModule.

Member Function Documentation

enabled() [1/2]

bool enabled

(

self

)

Gets whether this feature is currently enabled.

Returns

True if enabled; otherwise False.

Reimplemented from IFeature.

enabled() [2/2]

None enabled	(		self,
		bool	enabled )

Enables or disables the feature.

Parameters

enabled

True to enable, False to disable.

Reimplemented from IFeature.

range()

Interval range

(

self

)

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 the property x or y.

Returns

An IntervalU representing the valid decimation factor range.

reset_to_default()

None reset_to_default

(

self

)

Resets all settings to their defaults.

Default configuration:

• x = 1
• y = 1
• mode = DownsamplingMode.Decimation

Note

The enabled state does not change when calling this function.

Returns

Reimplemented from IFeature.

x() [1/2]

int x

(

self

)

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.

x() [2/2]

None x	(		self,
		int	value )

Sets the number of columns used for decimation.

Parameters

value

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 object.range.

Exceptions

OutOfRangeException

If value is outside the valid range.

y() [1/2]

int y

(

self

)

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.

y() [2/2]

None y	(		self,
		int	value )

Sets the number of rows used for decimation.

Parameters

value

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 object.range.

Exceptions

OutOfRangeException

If value is outside the valid range.

Field Documentation

_module

_module = module

protected