DigitalBlackFeature Class Reference

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

Inheritance diagram for DigitalBlackFeature:

Collaboration diagram for DigitalBlackFeature:

Public Member Functions
	DigitalBlackFeature (detail::ToneCurveCorrectionModule &module)
	Creates a DigitalBlackFeature for an existing tone curve 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
	Resets the digital black value to its default.
void	SetValue (float digitalBlack)
	Sets the digital black correction value.
float	GetValue () const
	Gets the current digital black correction value.
peak::common::IntervalF	GetRange () const
	Retrieves the valid range for the digital black value.

Detailed Description

Digital black applies digital black correction to an image.

This feature adjusts the image luminance by first subtracting a digital black and then normalizing the result. This compensates for sensor digital black offsets.

The correction is applied independently to each channel in the image. For RGB images, it is applied to each color channel (R, G, B), and for monochrome images, it is applied to the single intensity channel.

The correction is performed using the following formula:

color_value_out = clamp((color_value_in - black) / (1.0 - black), 0.0, 1.0);

where:

• color_value_in is the input channel value,
• black is the digital black to be subtracted (in normalized units),
• color_value_out is the resulting output value.

All input and output values are in the normalized range [0.0, 1.0].

Defaults

• black = 0.0

See also

features::GammaFeature, features::GainFeature

Since

1.0

Definition at line 55 of file peak_icv_digital_black_feature.hpp.

Constructor & Destructor Documentation

DigitalBlackFeature()

DigitalBlackFeature ( detail::ToneCurveCorrectionModule & module )

inlineexplicit

Creates a DigitalBlackFeature for an existing tone curve correction module.

Parameters

module

Reference to the underlying detail::ToneCurveCorrectionModule.

Since

1.0

Definition at line 124 of file peak_icv_digital_black_feature.hpp.

Member Function Documentation

GetRange()

peak::common::IntervalF GetRange ( ) const

inline

Retrieves the valid range for the digital black value.

The returned interval specifies the minimum and maximum values that can be passed to SetValue.

Returns

An IntervalF representing the valid digital black range.

Since

1.0

Definition at line 153 of file peak_icv_digital_black_feature.hpp.

GetValue()

float GetValue ( ) const

inline

Gets the current digital black correction value.

Returns

The digital black value currently set.

Since

1.0

Definition at line 148 of file peak_icv_digital_black_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 133 of file peak_icv_digital_black_feature.hpp.

ResetToDefault()

void ResetToDefault ( )

inlineoverridevirtual

Resets the digital black value to its default.

Note

The enabled state does not change when calling this function.

Since

1.0

Implements IFeature.

Definition at line 138 of file peak_icv_digital_black_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 128 of file peak_icv_digital_black_feature.hpp.

SetValue()

void SetValue ( float digitalBlack )

inline

Sets the digital black correction value.

This value is subtracted from the input image channel values before normalizing it. It typically represents sensor black offset.

Parameters

digitalBlack

A floating-point value representing the digital black value in normalized units. Valid values are within the range returned by GetRange.

Exceptions

OutOfRangeException

If digitalBlack is outside the valid range.

Since

1.0

Definition at line 143 of file peak_icv_digital_black_feature.hpp.