IFeature Class Reference

Inheritance diagram for IFeature:

Public Member Functions
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)
	Restores the feature's default values.

Detailed Description

Abstract base class for all image processing pipeline features.

IFeature defines the common interface that all pipeline features must implement. Features represent configurable image processing operations that can be enabled or disabled within an image processing pipeline.

Each feature provides:

• Enable/disable functionality through the enabled property
• Reset capability to restore default settings via reset_to_default()
• Feature-specific configuration methods (implemented in derived classes)

Features are typically used within a pipeline context where they can be selectively enabled or disabled to customize the image processing workflow. When a feature is disabled, it has no effect on the processed image.

Notes:

• All derived classes must implement the three abstract methods: enabled (getter/setter) and reset_to_default.
• The enabled state is independent of the feature's configuration. Calling reset_to_default() will reset the feature's parameters to their default values but will not change the enabled/disabled state.

# Assuming we have a concrete feature implementation
feature = SomeConcreteFeature()
# Enable the feature
feature.enabled = True
# Check if enabled
if feature.enabled:
    # Feature will be applied during processing
    pass
# Reset to default configuration (but keep enabled state)
feature.reset_to_default()

Since

ids_peak_icv 1.0

Definition at line 6 of file ifeature.py.

Member Function Documentation

enabled() [1/2]

bool enabled

(

self

)

Gets whether this feature is currently enabled.

Returns

True if enabled; otherwise False.

Since

ids_peak_icv 1.0

Reimplemented in BinningFeature, BinningFeature, ChromaticAdaptionFeature, ChromaticAdaptionFeature, ColorCorrectionFeature, ColorCorrectionFeature, DecimationFeature, DecimationFeature, DigitalBlackFeature, DigitalBlackFeature, GainFeature, GainFeature, GammaFeature, GammaFeature, HotpixelCorrectionFeature, HotpixelCorrectionFeature, MirrorFeature, MirrorFeature, RotationFeature, RotationFeature, SaturationFeature, SaturationFeature, SharpeningFeature, and SharpeningFeature.

Definition at line 50 of file ifeature.py.

enabled() [2/2]

None enabled	(		self,
		bool	enabled )

Enables or disables the feature.

Parameters

enabled

True to enable, False to disable.

Since

ids_peak_icv 1.0

Reimplemented in BinningFeature, BinningFeature, ChromaticAdaptionFeature, ChromaticAdaptionFeature, ColorCorrectionFeature, ColorCorrectionFeature, DecimationFeature, DecimationFeature, DigitalBlackFeature, DigitalBlackFeature, GainFeature, GainFeature, GammaFeature, GammaFeature, HotpixelCorrectionFeature, HotpixelCorrectionFeature, MirrorFeature, MirrorFeature, RotationFeature, RotationFeature, SaturationFeature, SaturationFeature, SharpeningFeature, and SharpeningFeature.

Definition at line 63 of file ifeature.py.

reset_to_default()

None reset_to_default

(

self

)

Restores the feature's default values.

Note

The enabled state does not change when calling this function.

Since

ids_peak_icv 1.0

Reimplemented in BinningFeature, ChromaticAdaptionFeature, ColorCorrectionFeature, DecimationFeature, DigitalBlackFeature, GainFeature, GammaFeature, HotpixelCorrectionFeature, MirrorFeature, RotationFeature, SaturationFeature, and SharpeningFeature.

Definition at line 75 of file ifeature.py.