colour_hdri.utilities.image Module

Image Data & Metadata Utilities

Defines various image data and metadata utilities classes:

class colour_hdri.utilities.image.Metadata[source]

Bases: colour_hdri.utilities.image.Metadata

Defines the base object for storing exif metadata relevant to HDRI / radiance image generation.

Parameters:
  • f_number (array_like) – Image FNumber.
  • exposure_time (array_like) – Image Exposure Time.
  • iso (array_like) – Image ISO.
  • black_level (array_like) – Image Black Level.
  • white_level (array_like) – Image White Level.
  • white_balance_multipliers (array_like) – Image white balance multipliers, usually the As Shot Neutral matrix.
class colour_hdri.utilities.image.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]
data

Property for self._data private attribute.

Returns:self._data.
Return type:unicode
metadata

Property for self._metadata private attribute.

Returns:self._metadata.
Return type:unicode
path

Property for self._path private attribute.

Returns:self._path.
Return type:unicode
read_data(decoding_cctf=None)[source]

Reads image pixel data at Image.path attribute.

Parameters:decoding_cctf (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
class colour_hdri.utilities.image.ImageStack[source]

Bases: collections.abc.MutableSequence

Defines a convenient stack storing a sequence of images for HDRI / radiance images generation.

ImageStack()
__init__()[source]
__getitem__()[source]
__setitem__()[source]
__delitem__()[source]
__len__()[source]
__getattr__()[source]
__setattr__()[source]
sort()[source]
insert()[source]
from_files()[source]
static from_files(image_files, decoding_cctf=None)[source]

Returns a ImageStack instance with given image files.

Parameters:
  • image_files (array_like) – Image files.
  • decoding_cctf (object, optional) – Decoding colour component transfer function (Decoding CCTF) or electro-optical transfer function (EOTF / EOCF).
Returns:
Return type:

ImageStack
insert(index, value)[source]

Reimplements the MutableSequence.insert() method.

Parameters:
  • index (int) – Item index.
  • value (object) – Item value.
sort(key=None)[source]

Sorts the underlying data structure.

Parameters:key (callable) – Function of one argument that is used to extract a comparison key from each data structure.