SharpeningFeature Class Reference

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

Inheritance diagram for SharpeningFeature:

Collaboration diagram for SharpeningFeature:

Public Member Functions
	SharpeningFeature (detail::SharpeningModule &module)
	Creates a SharpeningFeature for an existing sharpening module.
void	SetEnabled (bool enabled) override
	Enables or disables the feature.
bool	IsEnabled () const override
	Indicates whether the feature is currently enabled.
void	ResetToDefault () override
	Resets the sharpness level to the default value.
void	SetLevel (uint32_t level)
	Sets the sharpness level.
uint32_t	GetLevel () const
	Gets the current sharpness level.
peak::common::IntervalU	GetRange () const
	Retrieves the valid range for the sharpness level.

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

features::GammaFeature

Since

1.0

Definition at line 44 of file peak_icv_sharpening_feature.hpp.

Constructor & Destructor Documentation

SharpeningFeature()

SharpeningFeature ( detail::SharpeningModule & module )

inlineexplicit

Creates a SharpeningFeature for an existing sharpening module.

Parameters

module

Reference to the underlying detail::SharpeningModule.

Since

1.0

Definition at line 116 of file peak_icv_sharpening_feature.hpp.

Member Function Documentation

GetLevel()

uint32_t GetLevel ( ) const

inline

Gets the current sharpness level.

Returns

The sharpness level currently set.

Since

1.0

Definition at line 140 of file peak_icv_sharpening_feature.hpp.

GetRange()

peak::common::IntervalU GetRange ( ) const

inline

Retrieves the valid range for the sharpness level.

The returned interval specifies the minimum and maximum values that can be passed to SetLevel.

Returns

An IntervalU representing the valid sharpness level range.

Since

1.0

Definition at line 145 of file peak_icv_sharpening_feature.hpp.

IsEnabled()

bool IsEnabled ( ) const

inlineoverridevirtual

Indicates whether the feature is currently enabled.

Returns

true if enabled; otherwise, false.

Since

1.0

Implements IFeature.

Definition at line 125 of file peak_icv_sharpening_feature.hpp.

ResetToDefault()

void ResetToDefault ( )

inlineoverridevirtual

Resets the sharpness level to the default value.

Note

The enabled state does not change when calling this function.

Since

1.0

Implements IFeature.

Definition at line 130 of file peak_icv_sharpening_feature.hpp.

SetEnabled()

void SetEnabled ( bool enabled )

inlineoverridevirtual

Enables or disables the feature.

Parameters

enabled

Set to true to enable the feature, or false to disable it.

Since

1.0

Implements IFeature.

Definition at line 120 of file peak_icv_sharpening_feature.hpp.

SetLevel()

void SetLevel ( uint32_t level )

inline

Sets the sharpness level.

Parameters

level

An integer value representing the sharpness level. A value of 0 means no sharpening, higher values increase the effect. Valid values are within the range returned by GetRange.

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

OutOfRangeException

If level is outside the valid range.

See also

GetRange()

Since

1.0

Definition at line 135 of file peak_icv_sharpening_feature.hpp.