IDS peak ICV v1.4.0
Loading...
Searching...
No Matches
IFeature Interface Reference
Inheritance diagram for IFeature:

Public Member Functions

void ResetToDefault ()
 Restores the feature's default values.
 

Properties

bool IsEnabled [get, set]
 Enables or disables the feature.
 

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 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 pure virtual properties/methods: IsEnabled() and ResetToDefault().
Note
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
var feature = new SomeConcreteFeature();
// Enable the feature
feature.IsEnabled = 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
IDSImaging.Peak.ICV 1.3

Member Function Documentation

◆ ResetToDefault()

void ResetToDefault ( )

Restores the feature's default values.

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

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

Property Documentation

◆ IsEnabled