HotpixelCorrectionFeature Class Reference

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

Inheritance diagram for HotpixelCorrectionFeature:

Collaboration 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

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

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.

Note

Calling this function will overwrite any existing hot pixel list previously set via SetList().

Since

1.0

Definition at line 155 of file peak_icv_hotpixel_correction_feature.hpp.

GetList()

HotpixelCorrectionFeature::HotpixelList GetList ( ) const

inline

Retrieves the current list of known hot pixels.

Returns

A vector containing the positions of all configured hot pixels.

Since

1.0

Definition at line 145 of file peak_icv_hotpixel_correction_feature.hpp.

GetSensitivityRange()

peak::common::IntervalU GetSensitivityRange ( ) const

inline

Retrieves the valid range for the detection sensitivity.

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

Returns

An IntervalU representing the valid sensitivity range.

Since

1.0

Definition at line 150 of file peak_icv_hotpixel_correction_feature.hpp.

IsEnabled()

bool IsEnabled ( ) const

inlineoverridevirtual

Indicates whether the feature is currently enabled.

Returns

true if enabled; otherwise, false.

Since

1.0

Implements IFeature.

Definition at line 130 of file peak_icv_hotpixel_correction_feature.hpp.

ResetToDefault()

void ResetToDefault ( )

inlineoverridevirtual

Clears the hot pixel list.

Note

The enabled state does not change when calling this function.

Since

1.0

Implements IFeature.

Definition at line 135 of file peak_icv_hotpixel_correction_feature.hpp.

SetEnabled()

void SetEnabled ( bool enabled )

inlineoverridevirtual

Enables or disables the feature.

Parameters

enabled

Set to true to enable the feature, or false to disable it.

Since

1.0

Implements IFeature.

Definition at line 125 of file peak_icv_hotpixel_correction_feature.hpp.

SetList()

void SetList ( const HotpixelList & hotpixels )

inline

Sets the list of known hot pixels.

Parameters

hotpixels

A vector of hot pixel positions to use.

Since

1.0

Definition at line 140 of file peak_icv_hotpixel_correction_feature.hpp.