#include <peak_icv/pipeline/features/peak_icv_hotpixel_correction_feature.hpp>

Inheritance diagram for HotpixelCorrectionFeature:

Public Types
using	HotpixelList = std::vector<peak::common::Point>

Public Member Functions
	HotpixelCorrectionFeature (detail::HotpixelCorrectionModule &module)
	Creates a HotpixelCorrectionFeature for an existing hotpixel correction module.

void	SetEnabled (bool enabled) override
	Enables or disables the feature.

bool	IsEnabled () const override
	Indicates whether the feature is currently enabled.

void	ResetToDefault () override
	Clears the hot pixel list.

void	SetList (const HotpixelList &hotpixels)
	Sets the list of known hot pixels.

HotpixelList	GetList () const
	Retrieves the current list of known hot pixels.

peak::common::IntervalU	GetSensitivityRange () const
	Retrieves the valid range for the detection sensitivity.

void	Detect (const peak::icv::Image &image, uint32_t sensitivity=3, float gainFactor=1.0F)
	Performs immediate hot pixel detection on the given image.

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

Since: ids_peak_icv 1.0

Definition at line 36 of file peak_icv_hotpixel_correction_feature.hpp.

Member Typedef Documentation

◆ HotpixelList

using HotpixelList = std::vector<peak::common::Point>

Definition at line 39 of file peak_icv_hotpixel_correction_feature.hpp.

Constructor & Destructor Documentation

◆ HotpixelCorrectionFeature()

HotpixelCorrectionFeature ( detail::HotpixelCorrectionModule & module )

inlineexplicit

Creates a HotpixelCorrectionFeature for an existing hotpixel correction module.

Parameters

module Reference to the underlying detail::HotpixelCorrectionModule.

Since: ids_peak_icv 1.0

Definition at line 121 of file peak_icv_hotpixel_correction_feature.hpp.

Member Function Documentation

◆ Detect()

void Detect	(	const peak::icv::Image &	image,
		uint32_t	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 GetList().

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.