colour_hdri.Image

class colour_hdri.Image(path=None, data=None, metadata=None)[source]

Bases: object

Defines the base object for storing an image along its path, pixel data and metadata needed for HDRI / radiance images generation.

Parameters

  • path (unicode, optional) – Image path.

  • data (array_like, optional) – Image pixel data array.

  • metadata (Metadata, optional) – Image exif metadata.

path
data
metadata
read_data()[source]
read_metadata()[source]
property data

Property for self._data private attribute.

Returns

self._data.

Return type

unicode

property metadata

Property for self._metadata private attribute.

Returns

self._metadata.

Return type

unicode

property path

Property for self._path private attribute.

Returns

self._path.

Return type

unicode

read_data(cctf_decoding=None)[source]

Reads image pixel data at Image.path attribute.

Parameters

cctf_decoding (object, optional) – Decoding colour component transfer function (Decoding CCTF) or electro-optical transfer function (EOTF / EOCF).

Returns

Image pixel data.

Return type

ndarray

read_metadata()[source]

Reads image relevant exif metadata at Image.path attribute.

Returns

Image relevant exif metadata.

Return type

Metadata