SharpeningFeature Class Reference

Inheritance diagram for SharpeningFeature:

Public Member Functions
None	__init__ (self, SharpeningModule module)
	Initialize the SharpeningFeature to manage the specified sharpening module.
bool	enabled (self)
	Indicates whether the feature is currently enabled.
None	enabled (self, bool value)
	Enables or disables the feature.
None	reset_to_default (self)
	Resets the sharpness level to its default value 0.
int	level (self)
	Gets the current sharpness level.
None	level (self, int level)
	Sets the sharpness level.
Interval	range (self)
	Retrieves the valid range of sharpness levels.

Protected Attributes
	_module = module

Detailed Description

Provides access to sharpening settings within an image processing pipeline.

Supported pixel formats

Mono8 Mono10 Mono12 BGR8 BGRa8 RGB8 RGBa8 BGR10 BGRa10 RGB10

RGBa10 BGR12 BGRa12 RGB12 RGBa12

See the Pixel and Pixel Format Specifications for a detailed description of the pixel formats.

This feature emphasizes edges and fine structures by increasing contrast between adjacent pixels. The strength of the sharpening effect is controlled by the value property, where a value of 0 applies no sharpening. Higher values increase the sharpening effect.

Warning: Increasing the sharpness level can also amplify image noise and introduce visual artifacts such as halos around edges. Moderate values are recommended for optimal results.

The default level for sharpening is 0.

Since

ids_peak_icv 1.0

Definition at line 8 of file sharpening_feature.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		SharpeningModule	module )

Initialize the SharpeningFeature to manage the specified sharpening module.

Parameters

module

Reference to the underlying SharpeningModule

Since

ids_peak_icv 1.0

Definition at line 29 of file sharpening_feature.py.

Member Function Documentation

enabled() [1/2]

bool enabled

(

self

)

Indicates whether the feature is currently enabled.

Returns

True if enabled; otherwise, False.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

Definition at line 41 of file sharpening_feature.py.

enabled() [2/2]

None enabled	(		self,
		bool	value )

Enables or disables the feature.

Parameters

value

Set to True to enable the feature, or False to disable it.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

Definition at line 53 of file sharpening_feature.py.

level() [1/2]

int level

(

self

)

Gets the current sharpness level.

Returns

The current sharpening level.

Since

ids_peak_icv 1.0

Definition at line 76 of file sharpening_feature.py.

level() [2/2]

None level	(		self,
		int	level )

Sets the sharpness level.

Parameters

level

An integer representing the desired sharpness level. The acceptable range of values can be obtained from the range property.

Exceptions

OutOfRangeException

If the level is outside the valid range.

Since

ids_peak_icv 1.0

Definition at line 88 of file sharpening_feature.py.

range()

Interval range

(

self

)

Retrieves the valid range of sharpness levels.

Returns

An Interval object containing minimum and maximum allowed values.

Since

ids_peak_icv 1.0

Definition at line 103 of file sharpening_feature.py.

reset_to_default()

None reset_to_default

(

self

)

Resets the sharpness level to its default value 0.

Note

The enabled state is not changed when calling this function.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

Definition at line 64 of file sharpening_feature.py.

Field Documentation

_module

_module = module

protected

Definition at line 38 of file sharpening_feature.py.