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.MetadataDefines 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:
objectDefines 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¶
-
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()[source] Reads image pixel data at
Image.pathattribute.Returns: Image pixel data. Return type: ndarray
-
read_metadata()[source] Reads image relevant exif metadata at
Image.pathattribute.Returns: Image relevant exif metadata. Return type: Metadata
-
class
colour_hdri.utilities.image.ImageStack[source]¶ Bases:
_abcoll.MutableSequenceDefines a convenient stack storing a sequence of images for HDRI / radiance images generation.
-
ImageStack()¶
-
static
from_files(image_files)[source] Returns a
ImageStackinstance with given image files.Parameters: image_files (array_like) – Image files. Returns: Return type: ImageStack
-