Inheritance diagram for DownsamplingModule:

[legend]

Public Member Functions
None	__init__ (self, DownsamplingMode default_mode, str custom_type)
	Creates a DownsamplingModule with default values.

None	__del__ (self)

str	type (self)
	Returns the type of the pipeline for serialization purposes.

Image	process (self, Image input_image)
	Applies the downsampling factors and mode to the input image and returns a downsampled copy based on current settings.

None	reset_to_default (self)
	Resets all settings to their default values defined at initialization, i.e.

int	x (self)
	Returns the current number of columns used for downsampling.

None	x (self, int value)
	Sets the number of columns to downsample.

int	y (self)
	Returns the current number of rows used for downsampling.

None	y (self, int value)
	Sets the number of rows to downsample.

DownsamplingMode	mode (self)
	Returns the current DownsamplingMode.

None	mode (self, DownsamplingMode value)
	Sets the DownsamplingMode.

None	serialize (self, IArchive archive)
	Serializes the object's internal state into the provided archive.

None	deserialize (self, IArchive archive)
	Restores the object's state from the provided archive.

Interval	range (self)
	Returns the valid range for downsampling factors x and y.

Data Fields
int	x = 1):

int	y = self.DEFAULT_Y

	mode = self._default_mode

Static Public Attributes
int	DEFAULT_X = 1

int	DEFAULT_Y = 1

Protected Attributes
int	_x = self.DEFAULT_X

int	_y = self.DEFAULT_Y

	_mode = default_mode

	_default_mode = default_mode

	_type = custom_type

	_handle = peak_icv_downsampling_handle(None)

Detailed Description

Downsampling is used to decrease the image size.

This module provides comprehensive functionality for image downsampling, which is the process of reducing image resolution and dimensions. It supports multiple algorithms optimized for various use cases.

There are two basic techniques for downsampling:

Binning 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.
Decimation 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.

The reduction factors are specified separately for the x (columns) and y (rows) directions.

Since: ids_peak_icv 1.0

Definition at line 54 of file downsampling_module.py.

Constructor & Destructor Documentation

◆ init()

None __init__	(		self,
		DownsamplingMode	default_mode,
		str	custom_type )

Creates a DownsamplingModule with default values.

Parameters

default_mode	Override default mode, used when resetting the module to default
custom_type	Override custom mode, used when serialized to disk

Since: ids_peak_icv 1.0

Reimplemented from ModuleBase.

Definition at line 84 of file downsampling_module.py.

◆ del()

None __del__ ( self )

Definition at line 109 of file downsampling_module.py.

Member Function Documentation

◆ deserialize()

None deserialize	(		self,
		IArchive	archive )

Restores the object's state from the provided archive.

This function reads and applies all necessary parameters from the given archive to reconstruct the internal state of the object. It ensures that the object is restored to a valid and consistent state.

Parameters

archive The source archive containing the serialized parameters.

Exceptions

CorruptedException	If the archive is malformed, misses keys or the values are invalid
NotSupportedException	If the 'Version' entry indicates an unsupported version.

Note: This function requires that the archive contains all expected fields as produced by a corresponding serialize() call.

Since: ids_peak_icv 1.0

Reimplemented from ModuleBase.

Definition at line 275 of file downsampling_module.py.

◆ mode() [1/2]

DownsamplingMode mode ( self )

Returns the current DownsamplingMode.

Returns: The current DownsamplingMode.

Since: ids_peak_icv 1.0

Definition at line 230 of file downsampling_module.py.

◆ mode() [2/2]

None mode	(		self,
		DownsamplingMode	value )

Sets the DownsamplingMode.

Parameters

value The DownsamplingMode to set.

Since: ids_peak_icv 1.0

Definition at line 242 of file downsampling_module.py.

◆ process()

Image process	(		self,
		Image	input_image )

Applies the downsampling factors and mode to the input image and returns a downsampled copy based on current settings.

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

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

Note: Processes the entire image, ignoring any specified image region.; 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.

Parameters

input_image The input image to be processed.

Returns: A new image object that is the transformed result of the input.

Exceptions

NotSupportedException If input has any other than the supported pixel formats.

Since: ids_peak_icv 1.0

Definition at line 126 of file downsampling_module.py.

◆ range()

Interval range ( self )

Returns the valid range for downsampling factors x and y.

Returns: The valid range.

Since: ids_peak_icv 1.0

Definition at line 307 of file downsampling_module.py.

◆ reset_to_default()

None reset_to_default ( self )

Resets all settings to their default values defined at initialization, i.e.

x = 1, y = 1, and the initial downsampling mode.

Note: The enabled state and custom_type do not change when calling this function.

Since: ids_peak_icv 1.0

Definition at line 161 of file downsampling_module.py.

◆ serialize()

None serialize	(		self,
		IArchive	archive )

Serializes the object's internal state into the provided archive.

This function populates the object into an archive with all parameters required to fully represent the current state of the object. It ensures that the object can be reconstructed or transmitted accurately by saving all relevant data members in a consistent and structured format.

Parameters

archive The target archive that will store the serialized parameters.

Since: ids_peak_icv 1.0

Reimplemented from ModuleBase.

Definition at line 256 of file downsampling_module.py.

◆ type()

str type ( self )

Returns the type of the pipeline for serialization purposes.

Returns: Module type

Since: ids_peak_icv 1.0

Definition at line 115 of file downsampling_module.py.

◆ x() [1/2]

int x ( self )

Returns the current number of columns used for downsampling.

Returns: The current number of columns to downsample.

Since: ids_peak_icv 1.0

Definition at line 176 of file downsampling_module.py.

◆ x() [2/2]

None x	(		self,
		int	value )

Sets the number of columns to downsample.

Parameters

value The number of columns to downsample.

Since: ids_peak_icv 1.0

Definition at line 188 of file downsampling_module.py.

◆ y() [1/2]

int y ( self )

Returns the current number of rows used for downsampling.

Returns: The current number of rows to downsample.

Since: ids_peak_icv 1.0

Definition at line 203 of file downsampling_module.py.

◆ y() [2/2]

None y	(		self,
		int	value )

Sets the number of rows to downsample.

Parameters

value The number of rows to downsample.

Since: ids_peak_icv 1.0

Definition at line 215 of file downsampling_module.py.

Field Documentation

◆ _default_mode

_default_mode = default_mode

protected

Definition at line 98 of file downsampling_module.py.

◆ _handle

_handle = peak_icv_downsampling_handle(None)

protected

Definition at line 101 of file downsampling_module.py.

◆ _mode

_mode = default_mode

protected

Definition at line 97 of file downsampling_module.py.

◆ _type

_type = custom_type

protected

Definition at line 99 of file downsampling_module.py.

◆ _x

int _x = self.DEFAULT_X

protected

Definition at line 95 of file downsampling_module.py.

◆ _y

int _y = self.DEFAULT_Y

protected

Definition at line 96 of file downsampling_module.py.

◆ DEFAULT_X

int DEFAULT_X = 1

static

Definition at line 81 of file downsampling_module.py.

◆ DEFAULT_Y

int DEFAULT_Y = 1

static

Definition at line 82 of file downsampling_module.py.

◆ mode

mode = self._default_mode

Definition at line 173 of file downsampling_module.py.

◆ x

x = 1):

Definition at line 148 of file downsampling_module.py.

◆ y

y = self.DEFAULT_Y

Definition at line 172 of file downsampling_module.py.

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

◆ __del__()

Member Function Documentation

◆ deserialize()

◆ mode() [1/2]

◆ mode() [2/2]

◆ process()

◆ range()

◆ reset_to_default()

◆ serialize()

◆ type()

◆ x() [1/2]

◆ x() [2/2]

◆ y() [1/2]

◆ y() [2/2]

Field Documentation

◆ _default_mode

◆ _handle

◆ _mode

◆ _type

◆ _x

◆ _y

◆ DEFAULT_X

◆ DEFAULT_Y

◆ mode

◆ x

◆ y

◆ init()

◆ del()