Inheritance diagram for DigitalBlackFeature:

Public Member Functions
	DigitalBlackFeature (ToneCurveCorrectionModule module)
	Creates a DigitalBlackFeature for an existing tone curve correction module.

void	ResetToDefault ()
	Resets the digital black value to its default.

Properties
float	Value `[get, set]`
	Sets the digital black correction value.

IntervalF	Range `[get]`
	Retrieves the valid range for the digital black value.

bool	IsEnabled `[get, set]`
	Enables or disables the feature.

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 = Math.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: GammaFeature, GainFeature

Since: IDSImaging.Peak.ICV 1.3

Constructor & Destructor Documentation

◆ DigitalBlackFeature()

DigitalBlackFeature ( ToneCurveCorrectionModule module )

inline

Creates a DigitalBlackFeature for an existing tone curve correction module.

Parameters

module Reference to the underlying ToneCurveCorrectionModule.

Member Function Documentation

◆ ResetToDefault()

void ResetToDefault ( )

inline

Resets the digital black value to its default.

Note: The enabled state does not change when calling this function.

Implements IFeature.

Property Documentation

◆ IsEnabled

bool IsEnabled

getset

Enables or disables the feature.

Implements IFeature.

◆ Range

IntervalF Range

get

Retrieves the valid range for the digital black value.

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

◆ Value

float Value

getset

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. Valid values are within the Range.

Exceptions

IcvOutOfRangeException The digital black value is outside the valid range.

Public Member Functions

Properties