IDS peak ICV v1.1.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes
DecimationFeature Class Reference
IDS peak ICV » Python » Image Pipeline » Pipeline Features
Inheritance diagram for DecimationFeature:
Inheritance graph
[legend]

Public Member Functions

None __init__ (self, DownsamplingModule module)
 Creates a DecimationFeature for an existing downsampling module.
 
bool enabled (self)
 Indicates whether the feature is currently enabled.
 
None enabled (self, bool value)
 Enables or disables the feature.
 
None reset_to_default (self)
 Resets all settings to the default configuration:
 
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

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

Definition at line 8 of file decimation_feature.py.

Constructor & Destructor Documentation

◆ __init__()

None __init__ ( self,
DownsamplingModule module )

Creates a DecimationFeature for an existing downsampling module.

Parameters
modulemodule Reference to the underlying DownsamplingModule.

Definition at line 34 of file decimation_feature.py.

Member Function Documentation

◆ enabled() [1/2]

bool enabled ( self)

Indicates whether the feature is currently enabled.

Returns
True if enabled; otherwise, False.

Reimplemented from IFeature.

Definition at line 45 of file decimation_feature.py.

◆ enabled() [2/2]

None enabled ( self,
bool value )

Enables or disables the feature.

Parameters
valueSet to True to enable the feature, or False to disable it.

Reimplemented from IFeature.

Definition at line 54 of file decimation_feature.py.

◆ 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.

Definition at line 126 of file decimation_feature.py.

◆ reset_to_default()

None reset_to_default ( self)

Resets all settings to the default configuration:

  • x = 1
  • y = 1
  • DownsamplingMode.Decimation
Note
The enabled state does not change when calling this function.
Returns

Reimplemented from IFeature.

Definition at line 62 of file decimation_feature.py.

◆ 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.

Definition at line 77 of file decimation_feature.py.

◆ x() [2/2]

None x ( self,
int value )

Sets the number of columns used for decimation.

Parameters
valueThe 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
OutOfRangeExceptionIf value is outside the valid range.

Definition at line 88 of file decimation_feature.py.

◆ 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.

Definition at line 102 of file decimation_feature.py.

◆ y() [2/2]

None y ( self,
int value )

Sets the number of rows used for decimation.

Parameters
valueThe 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
OutOfRangeExceptionIf value is outside the valid range.

Definition at line 112 of file decimation_feature.py.

Field Documentation

◆ _module

_module = module
protected

Definition at line 42 of file decimation_feature.py.