IDS peak ICV v1.3.0
Loading...
Searching...
No Matches
ToneMapping Class Reference
Inheritance diagram for ToneMapping:

Data Structures

class  Handle
 

Public Member Functions

 ToneMapping ()
 Constructs a tone mapping object.
 
void Dispose ()
 Releases all resources associated with the tone mapping object.
 
Image Process (Image image)
 Applies tone mapping to an HDR image.
 

Properties

ToneMappingAlgorithm Algorithm [get]
 The tone mapping algorithm used by this object.
 

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 ToneMapping object.
  • Optionally query or set the tone mapping algorithm.
  • Call 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
IDSImaging.Peak.ICV 1.3

Definition at line 80 of file ToneMapping.cs.

Constructor & Destructor Documentation

◆ ToneMapping()

ToneMapping ( )
inline

Constructs a tone mapping object.

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

Since
IDSImaging.Peak.ICV 1.3

Definition at line 93 of file ToneMapping.cs.

Member Function Documentation

◆ Dispose()

void Dispose ( )
inline

Releases all resources associated with the tone mapping object.

Definition at line 121 of file ToneMapping.cs.

◆ Process()

Image Process ( Image image)
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
imageThe HDR image to be tone mapped.
Returns
The resulting tone mapped image with pixel format Mono8 resp. RGB8.
Since
IDSImaging.Peak.ICV 1.3

Definition at line 160 of file ToneMapping.cs.

Property Documentation

◆ Algorithm

ToneMappingAlgorithm Algorithm
get

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.

Since
IDSImaging.Peak.ICV 1.3

Definition at line 106 of file ToneMapping.cs.