ToneCurveCorrectionModule Class Reference

Inheritance diagram for ToneCurveCorrectionModule:

Data Structures
class	Handle

Public Member Functions
	ToneCurveCorrectionModule ()
	Creates an instance of class ToneCurveCorrectionModule.
void	Dispose ()
	Releases all resources used by this class.
override void	Serialize (IArchive archive)
	Serializes the object's internal state into the provided archive.
override void	Deserialize (IArchive archive)
	Restores the object's state from the provided archive.
override void	ResetToDefault ()
	Resets all parameters to their default values.
override Image	Process (Image input)
	Processes the input image and returns a tone curve corrected output image.
override object	Process (object input)
	Processes the input image and returns a tone curve corrected output image.

Properties
override string	TypeId [get]
	The unique type identifier for this module implementation.This should be a unique string identifying the specific implementation of the module.
override bool	IsEnabled [get, set]
	Gets or sets whether the module is enabled.
float	Gamma [get, set]
	The current gamma correction exponent.
IntervalF	GammaRange [get]
	Gets the valid range for the gamma correction exponent.
float	DigitalBlack [get, set]
	The current digital black used for digital black correction.
IntervalF	DigitalBlackRange [get]
	Gets the valid range for the digital black correction value.
int	Version = 1 [get]
	The module version.

Detailed Description

Tone curve correction is an image pipeline module that applies digital black correction and inverse gamma transformation to an image.

See also

DigitalBlackFeature, GammaFeature

Since

IDSImaging.Peak.ICV 1.3

Definition at line 19 of file ToneCurveCorrectionModule.cs.

Constructor & Destructor Documentation

ToneCurveCorrectionModule()

ToneCurveCorrectionModule ( )

inline

Creates an instance of class ToneCurveCorrectionModule.

Definition at line 37 of file ToneCurveCorrectionModule.cs.

Member Function Documentation

Deserialize()

override void Deserialize ( IArchive archive )

inlinevirtual

Restores the object's state from the provided archive.

This function reads and applies all necessary parameters from the given archive to reconstruct the internal state of the object. It ensures that the object is restored to a valid and consistent state.

Note

This function requires that the archive contains all expected fields as produced by a corresponding Serialize call.

Parameters

archive

The source archive containing the serialized parameters.

Exceptions

IcvCorruptedException	The archive is malformed, misses keys or the values are invalid.
IcvNotSupportedException	The Version entry indicates an unsupported version.
IcvOutOfRangeException	The values are outside of the valid range.

Reimplemented from ModuleBase.

Definition at line 247 of file ToneCurveCorrectionModule.cs.

Dispose()

void Dispose ( )

inline

Releases all resources used by this class.

Definition at line 186 of file ToneCurveCorrectionModule.cs.

Process() [1/2]

override Image Process ( Image input )

inline

Processes the input image and returns a tone curve corrected output image.

Note

Supported pixel formats: Mono8, Mono10, Mono12, Mono16, RGB8, RGB10, RGB12, BGR8, BGR10, BGR12, RGBa8, RGBa10, RGBa12, BGRa8, BGRa10, BGRa12. Images with other formats are passed through unmodified.

Note

This operation disregards any specified image regions and processes the entire image.

Parameters

input

The input image to be processed.

Returns

A new image with tone curve correction applied.

Definition at line 308 of file ToneCurveCorrectionModule.cs.

Process() [2/2]

override object Process ( object input )

inlinevirtual

Processes the input image and returns a tone curve corrected output image.

Note

Supported pixel formats: Mono8, Mono10, Mono12, Mono16, RGB8, RGB10, RGB12, BGR8, BGR10, BGR12, RGBa8, RGBa10, RGBa12, BGRa8, BGRa10, BGRa12. Images with other formats are passed through unmodified.

Note

This operation disregards any specified image regions and processes the entire image.

Parameters

input

The input image to be processed.

Returns

A new image with tone curve correction applied.

Reimplemented from ModuleBase.

Definition at line 350 of file ToneCurveCorrectionModule.cs.

ResetToDefault()

override void ResetToDefault ( )

inlinevirtual

Resets all parameters to their default values.

Default values:

• Gamma = 1.0f
• DigitalBlack = 0.0f

Note

The enabled state does not change when calling this function.

Reimplemented from ModuleBase.

Definition at line 281 of file ToneCurveCorrectionModule.cs.

Serialize()

override void Serialize ( IArchive archive )

inlinevirtual

Serializes the object's internal state into the provided archive.

This function populates the given archive with all parameters required to fully represent the current state of the object. It ensures that the object can be reconstructed or transmitted accurately by saving all relevant data members in a consistent and structured format.

Parameters

archive

The target archive that will store the serialized parameters.

Reimplemented from ModuleBase.

Definition at line 205 of file ToneCurveCorrectionModule.cs.

Property Documentation

DigitalBlack

float DigitalBlack

getset

The current digital black used for digital black correction.

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

Note

The digital black must be within the valid range returned by DigitalBlackRange

Definition at line 125 of file ToneCurveCorrectionModule.cs.

DigitalBlackRange

IntervalF DigitalBlackRange

get

Gets the valid range for the digital black correction value.

Returns

An IntervalF containing the minimum and maximum allowed digital black values.

Definition at line 145 of file ToneCurveCorrectionModule.cs.

Gamma

float Gamma

getset

The current gamma correction exponent.

This value determines the degree of inverse gamma correction applied during processing, where output values are computed as pow(input, 1/gamma). Higher gamma values lighten the image, while values closer to zero darken it.

Note

The gamma exponent must be within the valid range returned by GammaRange

Definition at line 76 of file ToneCurveCorrectionModule.cs.

GammaRange

IntervalF GammaRange

get

Gets the valid range for the gamma correction exponent.

Returns

An IntervalF containing the minimum and maximum allowed gamma values.

Definition at line 96 of file ToneCurveCorrectionModule.cs.

IsEnabled

override bool IsEnabled

getset

Gets or sets whether the module is enabled.

Implements IModule.

Definition at line 52 of file ToneCurveCorrectionModule.cs.

TypeId

override string TypeId

get

The unique type identifier for this module implementation.This should be a unique string identifying the specific implementation of the module.

Implements IModule.

Definition at line 49 of file ToneCurveCorrectionModule.cs.

Version

int Version = 1

getinherited

The module version.

Definition at line 20 of file ModuleBase.cs.