HotpixelDetection Class Reference

#include <peak_icv/algorithms/peak_icv_hotpixel_detection.hpp>

Public Member Functions
	HotpixelDetection ()
	Constructs a new HotpixelDetection instance.
	~HotpixelDetection ()
	HotpixelDetection (const HotpixelDetection &other)
	HotpixelDetection (HotpixelDetection &&other) noexcept
HotpixelDetection &	operator= (const HotpixelDetection &other)
HotpixelDetection &	operator= (HotpixelDetection &&other) noexcept
std::vector< peak::common::Point >	Detect (const Image &image) const
	Detects hot pixels in the provided image.
void	SetSensitivity (uint32_t sensitivity)
	Sets the sensitivity used during hot pixel detection.
uint32_t	GetSensitivity () const
	Returns the currently configured detection sensitivity.
peak::common::IntervalU	GetSensitivityRange ()
	Retrieves the valid range of sensitivity values.
void	SetGainFactor (float gainFactor)
	Sets the gain factor used during detection.
float	GetGainFactor () const
	Gets the current gain factor.

Detailed Description

Detects hot pixels in images taken by a camera by identifying anomalies in the pixels intensities.

The HotpixelDetection class performs analysis of images to identify hot pixels — pixels that consistently report abnormal intensity values. The detection sensitivity and gain factor can be configured to tune the detection accuracy.

Note

This class only performs hot pixel detection, not correction.

Since

1.0

Definition at line 36 of file peak_icv_hotpixel_detection.hpp.

Constructor & Destructor Documentation

HotpixelDetection() [1/3]

HotpixelDetection ( )

inline

Constructs a new HotpixelDetection instance.

Initializes internal resources for hot pixel detection.

Since

1.0

Definition at line 184 of file peak_icv_hotpixel_detection.hpp.

~HotpixelDetection()

~HotpixelDetection ( )

inline

Since

1.0

Definition at line 252 of file peak_icv_hotpixel_detection.hpp.

HotpixelDetection() [2/3]

HotpixelDetection ( const HotpixelDetection & other )

inline

Since

1.0

Definition at line 191 of file peak_icv_hotpixel_detection.hpp.

HotpixelDetection() [3/3]

HotpixelDetection ( HotpixelDetection && other )

inlinenoexcept

Since

1.0

Definition at line 201 of file peak_icv_hotpixel_detection.hpp.

Member Function Documentation

Detect()

std::vector< peak::common::Point > Detect ( const Image & image ) const

inline

Detects hot pixels in the provided image.

Analyzes the input image to identify hot pixels using the configured sensitivity and gain factor. The result is a list of points corresponding to detected hot pixels.

Parameters

image

The input image to analyze.

Returns

A vector of points representing detected hot pixels.

Since

1.0

Definition at line 153 of file peak_icv_hotpixel_detection.hpp.

GetGainFactor()

float GetGainFactor ( ) const

inline

Gets the current gain factor.

Returns

The configured gain factor value.

Since

1.0

Definition at line 292 of file peak_icv_hotpixel_detection.hpp.

GetSensitivity()

uint32_t GetSensitivity ( ) const

inline

Returns the currently configured detection sensitivity.

Returns

Current sensitivity value.

Since

1.0

Definition at line 272 of file peak_icv_hotpixel_detection.hpp.

GetSensitivityRange()

peak::common::IntervalU GetSensitivityRange ( )

inline

Retrieves the valid range of sensitivity values.

Returns

An IntervalU representing the allowed sensitivity range.

Since

1.0

Definition at line 277 of file peak_icv_hotpixel_detection.hpp.

operator=() [1/2]

HotpixelDetection & operator= ( const HotpixelDetection & other )

inline

Since

1.0

Definition at line 210 of file peak_icv_hotpixel_detection.hpp.

operator=() [2/2]

HotpixelDetection & operator= ( HotpixelDetection && other )

inlinenoexcept

Since

1.0

Definition at line 232 of file peak_icv_hotpixel_detection.hpp.

SetGainFactor()

void SetGainFactor ( float gainFactor )

inline

Sets the gain factor used during detection.

Higher gain values simulate conditions with more image noise, potentially improving detection accuracy under specific scenarios.

Parameters

gainFactor

The gain factor to apply (e.g., 1.0 for normal, >1.0 for higher gain).

Since

1.0

Definition at line 287 of file peak_icv_hotpixel_detection.hpp.

SetSensitivity()

void SetSensitivity ( uint32_t sensitivity )

inline

Sets the sensitivity used during hot pixel detection.

Parameters

sensitivity

A value within the valid sensitivity range.

Exceptions

OutOfRangeException

If the value is outside the valid range.

Since

1.0

Definition at line 260 of file peak_icv_hotpixel_detection.hpp.