IDS peak ICV v1.3.0
Loading...
Searching...
No Matches
IFeature Class Referenceabstract

#include <peak_icv/pipeline/features/peak_icv_ifeature.hpp>

Inheritance diagram for IFeature:

Public Member Functions

virtual ~IFeature ()=default
 
virtual void SetEnabled (bool enabled)=0
 Enables or disables the feature.
 
virtual bool IsEnabled () const =0
 Gets whether this feature is currently enabled.
 
virtual void ResetToDefault ()=0
 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 SetEnabled() and IsEnabled()
  • Reset capability to restore default settings via ResetToDefault()
  • 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.

Note
All derived classes must implement the three pure virtual methods: SetEnabled(), IsEnabled(), and ResetToDefault().
The enabled state is independent of the feature's configuration. Calling ResetToDefault() will reset the feature's parameters to their default values but will not change the enabled/disabled state.

Example usage:

// Assuming we have a concrete feature implementation
std::unique_ptr<IFeature> feature = std::make_unique<SomeConcreteFeature>();
// Enable the feature
feature->SetEnabled(true);
// Check if enabled
if (feature->IsEnabled()) {
// Feature will be applied during processing
}
// Reset to default configuration (but keep enabled state)
feature->ResetToDefault();
See also
ColorCorrectionFeature, SharpeningFeature, GainFeature
Since
ids_peak_icv 1.0

Definition at line 67 of file peak_icv_ifeature.hpp.

Constructor & Destructor Documentation

◆ ~IFeature()

virtual ~IFeature ( )
virtualdefault

Member Function Documentation

◆ IsEnabled()

virtual bool IsEnabled ( ) const
pure virtual

◆ ResetToDefault()

virtual void ResetToDefault ( )
pure virtual

Restores the feature's default values.

Note
The enabled state does not change when calling this function.
Since
ids_peak_icv 1.0

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

◆ SetEnabled()

virtual void SetEnabled ( bool enabled)
pure virtual

Enables or disables the feature.

Parameters
enabledSet to true to enable, or false to disable.
Since
ids_peak_icv 1.0

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