ViewTransform

PythonC++

class PyOpenColorIO.ViewTransform

A :ref:`ViewTransform` provides a conversion from the main (usually scene-referred) reference space to the display-referred reference space. This allows splitting the conversion from the main reference space to a display into two parts: the ViewTransform plus a display color space.

It is also possible to provide a ViewTransform that converts from the display-referred reference space back to that space. This is useful in cases when a ViewTransform is needed when converting between displays (such as HDR to SDR).

The ReferenceSpaceType indicates whether the ViewTransform converts from scene-to-display reference or display-to-display reference.

The from_reference transform direction is the one that is used when going out towards a display.

ViewTransform(*args, **kwargs)

Overloaded function.

1. __init__(self: PyOpenColorIO.PyOpenColorIO.ViewTransform, referenceSpace: PyOpenColorIO.PyOpenColorIO.ReferenceSpaceType) -> None

2. __init__(self: PyOpenColorIO.PyOpenColorIO.ViewTransform, referenceSpace: PyOpenColorIO.PyOpenColorIO.ReferenceSpaceType = <ReferenceSpaceType.REFERENCE_SPACE_SCENE: 0>, name: str = ‘’, family: str = ‘’, description: str = ‘’, toReference: PyOpenColorIO.PyOpenColorIO.Transform = None, fromReference: PyOpenColorIO.PyOpenColorIO.Transform = None, categories: collections.abc.Sequence[str] = []) -> None

addCategory(category: str) → None

clearCategories() → None

getCategories() → PyOpenColorIO.PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator

getDescription() → str

getFamily() → str

getInterchangeAttribute(attrName: str) → str

Get/Set the interchange attributes.

Currently the only supported attribute name is “amf_transform_ids”. Using any other name will throw. If the attribute is not defined, it will return an empty string. Setting the value to an empty string will effectively delete the attribute.

The AMF transform IDs are used to identify specific transforms in the ACES Metadata File. Multiple transform IDs can be specified in a newline-separated string.

getInterchangeAttributes() → dict[str, str]

getName() → str

getReferenceSpaceType() → PyOpenColorIO.PyOpenColorIO.ReferenceSpaceType

getTransform(direction: PyOpenColorIO.PyOpenColorIO.ViewTransformDirection) → PyOpenColorIO.PyOpenColorIO.Transform

If a transform in the specified direction has been specified, return it. Otherwise return a null ConstTransformRcPtr

hasCategory(category: str) → bool

removeCategory(category: str) → None

setDescription(description: str) → None

setFamily(family: str) → None

setInterchangeAttribute(attrName: str, attrValue: str) → None

setName(name: str) → None

setTransform(transform: PyOpenColorIO.PyOpenColorIO.Transform, direction: PyOpenColorIO.PyOpenColorIO.ViewTransformDirection) → None

Specify the transform for the appropriate direction. Setting the transform to null will clear it.

class PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator

self[arg0: SupportsInt | SupportsIndex] → str

iter(self) → PyOpenColorIO.PyOpenColorIO.ViewTransform.ViewTransformCategoryIterator

len(self) → int

next(self) → str