#include <peak_icv/algorithms/hdr/peak_icv_tone_mapping.hpp>

Inheritance diagram for ToneMapping:

Public Member Functions
	ToneMapping ()
	Constructs a tone mapping object.

	~ToneMapping () override
	Destroys the tone mapping object.

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

Image	Process (const Image &image) const
	Applies tone mapping to an HDR image.

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.

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 69 of file peak_icv_tone_mapping.hpp.

Constructor & Destructor Documentation

◆ ToneMapping()

ToneMapping ( )

inlineexplicit

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 142 of file peak_icv_tone_mapping.hpp.

◆ ~ToneMapping()

~ToneMapping ( )

inlineoverride

Destroys the tone mapping object.

Releases all resources associated with the tone mapping object.

Since: ids_peak_icv 1.2

Definition at line 149 of file peak_icv_tone_mapping.hpp.

Member Function Documentation

◆ GetAlgorithm()

ToneMappingAlgorithm GetAlgorithm ( ) const

inline

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 157 of file peak_icv_tone_mapping.hpp.

◆ Process()

Image Process ( const Image & image ) const

inline

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.

Supported pixel formats

Mono32fIDS
RGB32fIDS

See the Pixel and Pixel Format Specifications for a detailed description of the pixel formats.

Parameters

[in] image The HDR image to be tone mapped.

Returns: The resulting tone mapped image with pixel format Mono8 resp. RGB8.

Since: ids_peak_icv 1.2

Definition at line 173 of file peak_icv_tone_mapping.hpp.

Public Member Functions