HotpixelCorrectionFeature Class Reference

Inheritance diagram for HotpixelCorrectionFeature:

Public Member Functions
	HotpixelCorrectionFeature (HotpixelCorrectionModule module)
	Creates a HotpixelCorrectionFeature for an existing hotpixel correction module.
void	ResetToDefault ()
	Clears the hot pixel list.
void	Detect (Image image, uint sensitivity=3, float gainFactor=1.0F)
	Performs immediate hot pixel detection on the given image.

Properties
IEnumerable< Point >	HotpixelList [get, set]
	The list of hot pixels to be corrected.
IntervalU	SensitivityRange [get]
	Returns the valid range of sensitivities.
bool	IsEnabled [get, set]
	Enables or disables the feature.

Detailed Description

HotpixelCorrection detects and corrects hot pixels in camera images.

The HotpixelCorrection class is responsible for identifying and correcting defective pixels that consistently report higher-than-expected intensity values.

It allows fine-tuning of the detection sensitivity and management of a hot pixel correction list, which is applied during image processing.

Since

IDSImaging.Peak.ICV 1.3

Constructor & Destructor Documentation

HotpixelCorrectionFeature()

HotpixelCorrectionFeature ( HotpixelCorrectionModule module )

inline

Creates a HotpixelCorrectionFeature for an existing hotpixel correction module.

Parameters

module

Reference to the underlying HotpixelCorrectionModule.

Member Function Documentation

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 sensitivity setting. The results are stored internally and can be accessed using HotpixelList.

Note

Calling this function will overwrite any existing hot pixel list previously set via HotpixelList.

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.
gainFactor	Gain factor applied to the image. Used to account for increased noise levels when detecting hot pixels.

ResetToDefault()

void ResetToDefault ( )

inline

Clears the hot pixel list.

Note

The enabled state does not change when calling this function.

Implements IFeature.

Property Documentation

HotpixelList

IEnumerable<Point> HotpixelList

getset

The list of hot pixels to be corrected.

IsEnabled

bool IsEnabled

getset

Enables or disables the feature.

Implements IFeature.

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.