HotpixelCorrectionFeature Class Reference

Inheritance diagram for HotpixelCorrectionFeature:

Public Member Functions
None	__init__ (self, HotpixelCorrectionModule module)
	Creates a HotpixelCorrectionFeature for an existing hotpixel correction module.
bool	enabled (self)
	Gets whether this feature is currently enabled.
None	enabled (self, bool enabled)
	Enables or disables the feature.
None	reset_to_default (self)
	Resets the hotpixel list to its default value (empty list).
np.ndarray	hotpixel_list (self)
	Gets the current pixel list.
None	hotpixel_list (self, np.ndarray pixel_list)
	Sets the pixel list.
None	detect (self, Image image, int sensitivity=3, float gain_factor=1.0)
	Performs immediate hot pixel detection on the given image.

Protected Attributes
	_module = module

Detailed Description

HotpixelCorrection detects and corrects hot pixels in camera images.

Supported pixel formats

Mono8 Mono10 Mono12 BayerBG8 BayerBG10 BayerBG12 BayerGB8 BayerGB10 BayerGB12 BayerRG8

BayerRG10 BayerRG12 BayerGR8 BayerGR10 BayerGR12

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

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 through the process() method.

The default value is an empty hotpixel correction list.

Since

ids_peak_icv 1.0

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		HotpixelCorrectionModule	module )

Creates a HotpixelCorrectionFeature for an existing hotpixel correction module.

Parameters

module

Reference to the underlying module

Since

ids_peak_icv 1.0

Member Function Documentation

detect()

None detect	(		self,
		Image	image,
		int	sensitivity = 3,
		float	gain_factor = 1.0 )

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 pixel_list.

Note: Calling this function will overwrite any existing hot pixel list previously set via pixel_list.

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

Since

ids_peak_icv 1.0

enabled() [1/2]

bool enabled

(

self

)

Gets whether this feature is currently enabled.

Returns

True if enabled; otherwise False.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

enabled() [2/2]

None enabled	(		self,
		bool	enabled )

Enables or disables the feature.

Parameters

enabled

True to enable, False to disable.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

hotpixel_list() [1/2]

np.ndarray hotpixel_list

(

self

)

Gets the current pixel list.

Returns

The pixel list currently set.

Since

ids_peak_icv 1.0

hotpixel_list() [2/2]

None hotpixel_list	(		self,
		np.ndarray	pixel_list )

Sets the pixel list.

Parameters

pixel_list

A list of points representing the hotpixel.

Since

ids_peak_icv 1.0

reset_to_default()

None reset_to_default

(

self

)

Resets the hotpixel list to its default value (empty list).

Note

The enabled state does not change when calling this function.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

Field Documentation

_module

_module = module

protected