SharpeningModule Class Reference

Inheritance diagram for SharpeningModule:

Public Member Functions
override void	Serialize (IArchive archive)
	Serializes the object's internal state into the provided archive.
override void	Deserialize (IArchive archive)
	Restores the object's state from the provided archive.
override Image	Process (Image inputImage)
	Processes the input image and returns a sharpened output image.
override object	Process (object input)
	Processes the input image and returns a sharpened output image.
override void	ResetToDefault ()
	Resets the sharpness level to the default value (0).

Properties
override string	TypeId [get]
	The unique type identifier for this module implementation.This should be a unique string identifying the specific implementation of the module.
uint	Level [get, set]
	The current sharpness level.
IntervalU	LevelRange [get]
	Gets the valid range for the sharpness level.
int	Version = 1 [get]
	The module version.
virtual bool	IsEnabled = true [get, set]
	Get whether this module is enabled.

Detailed Description

Sharpening is an image pipeline module that applies a sharpening filter to enhance image detail.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 16 of file SharpeningModule.cs.

Member Function Documentation

Deserialize()

override void Deserialize ( IArchive archive )

inlinevirtual

Restores the object's state from the provided archive.

This function reads and applies all necessary parameters from the given archive to reconstruct the internal state of the object. It ensures that the object is restored to a valid and consistent state.

Note

This function requires that the archive contains all expected fields as produced by a corresponding Serialize call.

Parameters

archive

The source archive containing the serialized parameters.

Exceptions

IcvCorruptedException	The archive is malformed, misses keys or the values are invalid.
IcvNotSupportedException	The Version entry indicates an unsupported version.
IcvOutOfRangeException	The values are outside of the valid range.

Reimplemented from ModuleBase.

Definition at line 117 of file SharpeningModule.cs.

Process() [1/2]

override Image Process ( Image inputImage )

inline

Processes the input image and returns a sharpened output image.

Note

Supported pixel formats: Mono8, Mono10, Mono12, RGB8, RGB10, RGB12, BGR8, BGR10, BGR12, RGBa8, RGBa10, RGBa12, BGRa8, BGRa10, BGRa12. Images with other formats are passed through unmodified.

Note

This operation disregards any specified image regions and processes the entire image.

Parameters

inputImage

The input image to be processed.

Returns

A new image with sharpening applied.

Definition at line 144 of file SharpeningModule.cs.

Process() [2/2]

override object Process ( object input )

inlinevirtual

Processes the input image and returns a sharpened output image.

Note

Supported pixel formats: Mono8, Mono10, Mono12, RGB8, RGB10, RGB12, BGR8, BGR10, BGR12, RGBa8, RGBa10, RGBa12, BGRa8, BGRa10, BGRa12. Images with other formats are passed through unmodified.

Note

This operation disregards any specified image regions and processes the entire image.

Parameters

input

The input image to be processed.

Returns

A new image with sharpening applied.

Reimplemented from ModuleBase.

Definition at line 189 of file SharpeningModule.cs.

ResetToDefault()

override void ResetToDefault ( )

inlinevirtual

Resets the sharpness level to the default value (0).

Note

The enabled state does not change when calling this function.

Reimplemented from ModuleBase.

Definition at line 201 of file SharpeningModule.cs.

Serialize()

override void Serialize ( IArchive archive )

inlinevirtual

Serializes the object's internal state into the provided archive.

This function populates the given archive with all parameters required to fully represent the current state of the object. It ensures that the object can be reconstructed or transmitted accurately by saving all relevant data members in a consistent and structured format.

Parameters

archive

The target archive that will store the serialized parameters.

Reimplemented from ModuleBase.

Definition at line 83 of file SharpeningModule.cs.

Property Documentation

IsEnabled

virtual bool IsEnabled = true

getsetinherited

Get whether this module is enabled.

When disabled, Process returns the input image unchanged.

Implements IModule.

Definition at line 28 of file ModuleBase.cs.

Level

uint Level

getset

The current sharpness level.

Note

Higher sharpness levels may increase noise in the output image.

Note

The sharpness level must be within the valid LevelRange.

Exceptions

IcvOutOfRangeException

The value is outside the valid range.

Definition at line 43 of file SharpeningModule.cs.

LevelRange

IntervalU LevelRange

get

Gets the valid range for the sharpness level.

Definition at line 61 of file SharpeningModule.cs.

TypeId

override string TypeId

get

The unique type identifier for this module implementation.This should be a unique string identifying the specific implementation of the module.

Implements IModule.

Definition at line 25 of file SharpeningModule.cs.

Version

int Version = 1

getinherited

The module version.

Definition at line 20 of file ModuleBase.cs.