IDS peak ICV v1.1.0
Loading...
Searching...
No Matches
IAutoFeature Class Reference
Inheritance diagram for IAutoFeature:

Public Member Functions

None set_gain_module (self, IGain|None gain_module)
 Called by the pipeline to set the gain module for the auto feature module.
 
None set_color_correction_matrix (self, Sequence[float] matrix)
 Notifies the auto feature module of the currently used color correction matrix.
 

Detailed Description

Interface for modules that provide auto feature functionality.

Defines the necessary functions that any auto feature module must implement.

Since
ids_peak_common 1.1

Definition at line 8 of file iautofeature_module.py.

Member Function Documentation

◆ set_color_correction_matrix()

None set_color_correction_matrix ( self,
Sequence[float] matrix )

Notifies the auto feature module of the currently used color correction matrix.

Allows the auto feature module to adjust its algorithms and gain values based on the provided color correction matrix.

Parameters
matrixThe 3x3 color correction matrix currently in use.
Since
ids_peak_common 1.1

Definition at line 35 of file iautofeature_module.py.

◆ set_gain_module()

None set_gain_module ( self,
IGain | None gain_module )

Called by the pipeline to set the gain module for the auto feature module.

This function provides the gain module that the auto feature module can use to apply gain adjustments as needed.

Parameters
gain_moduleThe gain module to be controlled by the auto feature module or None if no gain module should be set.
Since
ids_peak_common 1.1

Definition at line 19 of file iautofeature_module.py.