Inheritance diagram for SharpeningFeature:

Public Member Functions
	SharpeningFeature (SharpeningModule module)
	Creates a SharpeningFeature using an existing sharpening module.

void	ResetToDefault ()
	Resets the sharpness level to the default value.

Properties
uint	Level `[get, set]`
	The current sharpness level.

IntervalU	LevelRange `[get]`
	Gets the valid range for the sharpness level.

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

Detailed Description

Sharpening applies a sharpening filter to enhance image detail.

It enhances edges and fine structures by emphasizing high-frequency components in the image.

The strength of the effect is controlled by the sharpness level, where 0 results in no change.

Warning: Increasing the sharpness level can also amplify image noise, especially at higher values. Excessive sharpening may introduce artifacts such as halos around edges.

Defaults

level = 0

See also: Pipeline.Features.GammaFeature

Since: IDSImaging.Peak.ICV 1.3

Definition at line 30 of file SharpeningFeature.cs.

Constructor & Destructor Documentation

◆ SharpeningFeature()

SharpeningFeature ( SharpeningModule module )

inline

Creates a SharpeningFeature using an existing sharpening module.

Parameters

module Reference to the underlying SharpeningModule.

Definition at line 40 of file SharpeningFeature.cs.

Member Function Documentation

◆ ResetToDefault()

void ResetToDefault ( )

inline

Resets the sharpness level to the default value.

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

Implements IFeature.

Definition at line 90 of file SharpeningFeature.cs.

Property Documentation

◆ IsEnabled

bool IsEnabled

getset

Enables or disables the feature.

Implements IFeature.

Definition at line 77 of file SharpeningFeature.cs.

◆ Level

uint Level

getset

The current sharpness level.

A value of 0 means no sharpening; higher values increase the effect. Valid values are within the LevelRange.

Warning: Higher sharpness levels may increase noise in the output image and introduce artifacts such as halos around edges. Use moderate values for best results.

Exceptions

IcvOutOfRangeException The value is outside the valid range.

Definition at line 62 of file SharpeningFeature.cs.

◆ LevelRange

IntervalU LevelRange

get

Gets the valid range for the sharpness level.

The returned interval specifies the minimum and maximum values that can be assigned to Level.

Definition at line 74 of file SharpeningFeature.cs.

Public Member Functions

Properties