Public Member Functions
None	__init__ (self, Any args, *Any kwargs)
	Constructs a tone mapping object.

None	__del__ (self)
	Destroys the tone mapping object.

ToneMappingAlgorithm	algorithm (self)
	Returns the tone mapping algorithm used by this object.

None	algorithm (self, ToneMappingAlgorithm algorithm)
	Sets the tone mapping algorithm.

Image	process (self, Image image)
	Applies tone mapping to an HDR image.

Protected Attributes
	_handle = peak_icv_tone_mapping_handle()

Detailed Description

Performs tone mapping on HDR images.

This class provides functionality to convert a High Dynamic Range (HDR) image into a displayable Low Dynamic Range (LDR) image using a tone mapping algorithm.

Internally, tone mapping is performed using the Reinhard tone mapping operator, which is currently the only supported algorithm. The algorithm is fixed at object creation time.

Typical usage

Create a :class:ToneMapping object
Optionally query or set the tone mapping algorithm
Call :meth:process to convert an HDR image into an LDR image

Limitations

The input image must be a valid HDR image.
Only the Reinhard tone mapping algorithm is currently supported.

Since: ids_peak_icv 1.2

Definition at line 45 of file tone_mapping.py.

Constructor & Destructor Documentation

◆ init()

None __init__	(		self,
		*Any	args,
		**Any	kwargs )

Constructs a tone mapping object.

Creates and initializes a tone mapping object using the default tone mapping algorithm (Reinhard).

Since: ids_peak_icv 1.2

Definition at line 71 of file tone_mapping.py.

◆ del()

None __del__ ( self )

Destroys the tone mapping object.

Releases all resources associated with the tone mapping object.

Since: ids_peak_icv 1.2

Definition at line 87 of file tone_mapping.py.

Member Function Documentation

◆ algorithm() [1/2]

ToneMappingAlgorithm algorithm ( self )

Returns the tone mapping algorithm used by this object.

The algorithm is defined at construction time and determines how the input HDR image is converted into a displayable image.

Returns: The tone mapping algorithm identifier.

Since: ids_peak_icv 1.2

Definition at line 100 of file tone_mapping.py.

◆ algorithm() [2/2]

None algorithm	(		self,
		ToneMappingAlgorithm	algorithm )

Sets the tone mapping algorithm.

Parameters

algorithm The tone mapping algorithm to use.

Since: ids_peak_icv 1.2

Definition at line 122 of file tone_mapping.py.

◆ process()

Image process	(		self,
		Image	image )

Applies tone mapping to an HDR image.

Processes the provided HDR image and converts it into a displayable Low Dynamic Range (LDR) image using the tone mapping algorithm associated with this object.

The input image must be compatible with the tone mapping configuration.

Parameters

image The HDR image to be tone mapped.

Returns: The resulting tone-mapped image.

Since: ids_peak_icv 1.2

Definition at line 138 of file tone_mapping.py.

Field Documentation

◆ _handle

_handle = peak_icv_tone_mapping_handle()

protected

Definition at line 81 of file tone_mapping.py.

Public Member Functions

Protected Attributes