IDS peak ICV v1.2.0
Loading...
Searching...
No Matches
HDR Class Reference

Public Member Functions

None __init__ (self, *Any args, **Any kwargs)
 Creates an HDR processing object using the default HDR algorithm.
 
None __del__ (self)
 Destroys the HDR object and releases backend resources.
 
HDRAlgorithm algorithm (self)
 
None calibrate (self, ImageArray images)
 Performs an optional HDR calibration step.
 
Image process (self, ImageArray images)
 Generates an HDR image from the specified input images.
 

Protected Attributes

 _handle = peak_icv_hdr_handle()
 

Detailed Description

Performs High Dynamic Range (HDR) image reconstruction.

This class combines multiple images of the same scene captured with different exposure settings into a single HDR image.

Internally, the Debevec algorithm is used. The algorithm is fixed at construction time.

Typical usage

  • Create an HDR object
  • Optionally call :meth:calibrate
  • Call :meth:process to generate the HDR image
Since
ids_peak_icv 1.2

Definition at line 48 of file hdr.py.

Constructor & Destructor Documentation

◆ __init__()

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

Creates an HDR processing object using the default HDR algorithm.

Since
ids_peak_icv 1.2

Definition at line 68 of file hdr.py.

◆ __del__()

None __del__ ( self)

Destroys the HDR object and releases backend resources.

Since
ids_peak_icv 1.2

Definition at line 81 of file hdr.py.

Member Function Documentation

◆ algorithm()

HDRAlgorithm algorithm ( self)
Returns
The HDR reconstruction algorithm used by this object.
Since
ids_peak_icv 1.2

Definition at line 92 of file hdr.py.

◆ calibrate()

None calibrate ( self,
ImageArray images )

Performs an optional HDR calibration step.

Calibration estimates camera response characteristics and may reduce processing time when calling :meth:process.

Parameters
imagesImages of the same scene with different exposure settings. Must not be empty.
Since
ids_peak_icv 1.2

Definition at line 108 of file hdr.py.

◆ process()

Image process ( self,
ImageArray images )

Generates an HDR image from the specified input images.

If the HDR object was not explicitly calibrated using :meth:calibrate, calibration is performed implicitly.

Parameters
imagesImages of the same scene with different exposure settings. All input images must contain exposure time metadata. Must not be empty.
Returns
The resulting HDR image.
Since
ids_peak_icv 1.2

Definition at line 140 of file hdr.py.

Field Documentation

◆ _handle

_handle = peak_icv_hdr_handle()
protected

Definition at line 75 of file hdr.py.