HotpixelCorrectionModule Class Reference

Inheritance diagram for HotpixelCorrectionModule:

Data Structures
class	Handle

Public Member Functions
	HotpixelCorrectionModule ()
	Creates an instance of class HotpixelCorrectionModule.
void	Dispose ()
	Releases all resources used by this class.
override Image	Process (Image inputImage)
	Applies hot pixel correction to the input image in place and returns a reference to the modified image.
override object	Process (object input)
	Applies hot pixel correction to the input image in place and returns a reference to the modified image.
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.
void	Detect (Image image, uint sensitivity=3, float gainFactor=1.0F)
	Performs immediate hot pixel detection on the given image.
override void	ResetToDefault ()
	Clears the hot pixel list.

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.
IEnumerable< Point >	HotpixelList [get, set]
	The current list of known hot pixels.
IntervalU	SensitivityRange [get]
	Returns the valid range of sensitivities.
int	Version = 1 [get]
	The module version.
virtual bool	IsEnabled = true [get, set]
	Get whether this module is enabled.

Detailed Description

Hotpixel correction is an image pipeline module for detecting and correcting hot pixels in camera images.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 19 of file HotpixelCorrectionModule.cs.

Constructor & Destructor Documentation

HotpixelCorrectionModule()

HotpixelCorrectionModule ( )

inline

Creates an instance of class HotpixelCorrectionModule.

Definition at line 30 of file HotpixelCorrectionModule.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 239 of file HotpixelCorrectionModule.cs.

Detect()

void Detect ( Image image, uint sensitivity = 3, float gainFactor = 1::0F )

inline

Performs immediate hot pixel detection on the given image.

This method analyzes the provided image and detects hot pixels based on the current sensitivity setting. The results are stored internally and can be accessed using GetList().

Note

Supported pixel formats: BayerGR8, BayerGR10, BayerGR12, BayerRG8, BayerRG10, BayerRG12, BayerGB8, BayerGB10, BayerGB12, BayerBG8, BayerBG10, BayerBG12, Mono8, Mono10, Mono12

Warning

Calling this function will overwrite any existing hot pixel list previously set via SetList(). All previously configured hot pixel positions will be lost.

Parameters

image	The input image to analyze for hot pixel detection.
sensitivity	Sensitivity for hot pixel detection. A higher sensitivity may result in detecting more hot pixels, including possible false positives. Valid values are within the range returned by SensitivityRange.
gainFactor	Gain factor applied to the image (typically 1.0 or higher). Used to account for increased noise levels when detecting hot pixels. Higher gain factors may require higher sensitivity values for effective detection.

Exceptions

IcvOutOfRangeException	The sensitivity value is outside the valid range.
IcvNotSupportedException	The image has any other than the supported pixel formats.

See also

HotpixelList, SensitivityRange

Definition at line 294 of file HotpixelCorrectionModule.cs.

Dispose()

void Dispose ( )

inline

Releases all resources used by this class.

Definition at line 93 of file HotpixelCorrectionModule.cs.

Process() [1/2]

override Image Process ( Image inputImage )

inline

Applies hot pixel correction to the input image in place and returns a reference to the modified image.

The correction is performed based on the current configuration of the module. The operation modifies the input image directly and does not create a copy.

Note

Supported pixel formats: BayerGR8, BayerGR10, BayerGR12, BayerRG8, BayerRG10, BayerRG12, BayerGB8, BayerGB10, BayerGB12, BayerBG8, BayerBG10, BayerBG12, Mono8, Mono10, Mono12.

Note

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

Parameters

inputImage

The input image to be processed and corrected.

Returns

A reference to the input image after in-place hot pixel correction.

Exceptions

IcvNotSupportedException

The inputImage has any other than the supported pixel formats.

Definition at line 128 of file HotpixelCorrectionModule.cs.

Process() [2/2]

override object Process ( object input )

inlinevirtual

Applies hot pixel correction to the input image in place and returns a reference to the modified image.

The correction is performed based on the current configuration of the module. The operation modifies the input image directly and does not create a copy.

Note

Supported pixel formats: BayerGR8, BayerGR10, BayerGR12, BayerRG8, BayerRG10, BayerRG12, BayerGB8, BayerGB10, BayerGB12, BayerBG8, BayerBG10, BayerBG12, Mono8, Mono10, Mono12.

Note

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

Parameters

input

The input image to be processed and corrected.

Returns

A reference to the input image after in-place hot pixel correction.

Exceptions

IcvNotSupportedException

The input has any other than the supported pixel formats.

Reimplemented from ModuleBase.

Definition at line 179 of file HotpixelCorrectionModule.cs.

ResetToDefault()

override void ResetToDefault ( )

inlinevirtual

Clears the hot pixel list.

Note

The enabled state does not change when calling this function.

Reimplemented from ModuleBase.

Definition at line 308 of file HotpixelCorrectionModule.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 195 of file HotpixelCorrectionModule.cs.

Property Documentation

HotpixelList

IEnumerable<Point> HotpixelList

getset

The current list of known hot pixels.

Definition at line 44 of file HotpixelCorrectionModule.cs.

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.

SensitivityRange

IntervalU SensitivityRange

get

Returns the valid range of sensitivities.

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

Definition at line 78 of file HotpixelCorrectionModule.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 39 of file HotpixelCorrectionModule.cs.

Version

int Version = 1

getinherited

The module version.

Definition at line 20 of file ModuleBase.cs.