Processors¶

Processor¶

class PyOpenColorIO.Processor¶

Processor(*args, **kwargs)¶

createGroupTransform() → PyOpenColorIO.PyOpenColorIO.GroupTransform¶

getCacheID() → str¶

getDefaultCPUProcessor() → PyOpenColorIO.PyOpenColorIO.CPUProcessor¶

getDefaultGPUProcessor() → PyOpenColorIO.PyOpenColorIO.GPUProcessor¶

getDynamicProperty(type: PyOpenColorIO.PyOpenColorIO.DynamicPropertyType) → PyOpenColorIO.PyOpenColorIO.DynamicProperty¶

getFormatMetadata() → PyOpenColorIO.PyOpenColorIO.FormatMetadata¶

getOptimizedCPUProcessor(*args, **kwargs)¶

Overloaded function.

getOptimizedCPUProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.CPUProcessor
getOptimizedCPUProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, inBitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, outBitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.CPUProcessor

getOptimizedGPUProcessor(oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) → PyOpenColorIO.PyOpenColorIO.GPUProcessor¶

getOptimizedProcessor(*args, **kwargs)¶

Overloaded function.

getOptimizedProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.Processor
getOptimizedProcessor(self: PyOpenColorIO.PyOpenColorIO.Processor, inBitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, outBitDepth: PyOpenColorIO.PyOpenColorIO.BitDepth, oFlags: PyOpenColorIO.PyOpenColorIO.OptimizationFlags) -> PyOpenColorIO.PyOpenColorIO.Processor

getProcessorMetadata() → PyOpenColorIO.PyOpenColorIO.ProcessorMetadata¶

getTransformFormatMetadata() → PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator¶

hasChannelCrosstalk() → bool¶

hasDynamicProperty(type: PyOpenColorIO.PyOpenColorIO.DynamicPropertyType) → bool¶

isDynamic() → bool¶

isNoOp() → bool¶

class PyOpenColorIO.Processor.TransformFormatMetadataIterator¶

self[arg0: SupportsInt] → PyOpenColorIO.PyOpenColorIO.FormatMetadata¶

iter(self) → PyOpenColorIO.PyOpenColorIO.Processor.TransformFormatMetadataIterator¶

len(self) → int¶

next(self) → PyOpenColorIO.PyOpenColorIO.FormatMetadata¶

class Processor¶

The Processor represents a specific color transformation which is the result of Config::getProcessor.

Public Functions

bool isNoOp() const¶

bool hasChannelCrosstalk() const¶: True if the image transformation is non-separable. For example, if a change in red may also cause a change in green or blue.

const char *getCacheID() const¶: Returns a hash string generated by hashing the cachedIDs of the (unoptimized) list of ops contained in the Processor. (This forms part of the key used by the config’s processor cache.)

ConstProcessorMetadataRcPtr getProcessorMetadata() const¶: The ProcessorMetadata contains technical information such as the number of files and looks used in the processor.

const FormatMetadata &getFormatMetadata() const¶: Get a FormatMetadata containing the top level metadata for the processor. For a processor from a CLF file, this corresponds to the ProcessList metadata.

int getNumTransforms() const¶: Get the number of transforms that comprise the processor. Each transform has a (potentially empty) FormatMetadata.

const FormatMetadata &getTransformFormatMetadata(int index) const¶: Get a FormatMetadata containing the metadata for a transform within the processor. For a processor from a CLF file, this corresponds to the metadata associated with an individual process node.

GroupTransformRcPtr createGroupTransform() const¶: Return a GroupTransform that contains a copy of the transforms that comprise the processor. (Changes to it will not modify the original processor.) Note that the GroupTransform::write method may be used to serialize a Processor. Serializing to CTF format is a useful technique for debugging Processor contents.

DynamicPropertyRcPtr getDynamicProperty(DynamicPropertyType type) const¶: The returned pointer may be used to set the default value of any dynamic properties of the requested type. Throws if the requested property is not found. Note that if the processor contains several ops that support the requested property, only one can be dynamic and only this one will be controlled.

Note

The dynamic properties are a convenient way to change on-the-fly values without generating again and again a CPU or GPU processor instance. Color transformations can contain dynamic properties from a ExposureContrastTransform for example. So, Processor, CPUProcessor and GpuShaderCreator all have ways to manage dynamic properties. However, the transform dynamic properties are decoupled between the types of processor instances so that the same Processor can generate several independent CPU and/or GPU processor instances i.e. changing the value of the exposure dynamic property from a CPU processor instance does not affect the corresponding GPU processor instance. Processor creation will log a warning if there are more than one property of a given type. There may be more than one property of a given type, but only one will respond to parameter updates, the others will use their original parameter values.

bool hasDynamicProperty(DynamicPropertyType type) const noexcept¶: True if at least one dynamic property of that type exists.

bool isDynamic() const noexcept¶: True if at least one dynamic property of any type exists and is dynamic.

ConstProcessorRcPtr getOptimizedProcessor(OptimizationFlags oFlags) const¶: Run the optimizer on a Processor to create a new Processor. It is usually not necessary to call this since getting a CPUProcessor or GPUProcessor will also optimize. However if you need both, calling this method first makes getting a CPU and GPU Processor faster since the optimization is effectively only done once.

ConstProcessorRcPtr getOptimizedProcessor(BitDepth inBD, BitDepth outBD, OptimizationFlags oFlags) const¶: Create a Processor that is optimized for a specific in and out bit-depth (as CPUProcessor would do). This method is provided primarily for diagnostic purposes.

ConstGPUProcessorRcPtr getDefaultGPUProcessor() const¶: Get an optimized GPUProcessor instance.

ConstGPUProcessorRcPtr getOptimizedGPUProcessor(OptimizationFlags oFlags) const¶

ConstGPUProcessorRcPtr getOptimizedLegacyGPUProcessor(OptimizationFlags oFlags, unsigned edgelen) const¶: Get an optimized GPUProcessor instance that will emulate the OCIO v1 GPU path. This approach bakes some of the ops into a single Lut3D and so is less accurate than the current GPU processing methods.

ConstCPUProcessorRcPtr getDefaultCPUProcessor() const¶

Get an optimized CPUProcessor instance.

OCIO::ConstConfigRcPtr config = OCIO::GetCurrentConfig();

OCIO::ConstProcessorRcPtr processor
    = config->getProcessor(colorSpace1, colorSpace2);

OCIO::ConstCPUProcessorRcPtr cpuProcessor
    = processor->getDefaultCPUProcessor();

OCIO::PackedImageDesc img(imgDataPtr, imgWidth, imgHeight, imgChannels);
cpuProcessor->apply(img);

Note

This may provide higher fidelity than anticipated due to internal optimizations. For example, if the inputColorSpace and the outputColorSpace are members of the same equalitygroup, no conversion will be applied, even though strictly speaking quantization should be added.

Note

The typical use case to apply color processing to an image is:

ConstCPUProcessorRcPtr getOptimizedCPUProcessor(OptimizationFlags oFlags) const¶

ConstCPUProcessorRcPtr getOptimizedCPUProcessor(BitDepth inBitDepth, BitDepth outBitDepth, OptimizationFlags oFlags) const¶

Processor(const Processor&) = delete¶

Processor &operator=(const Processor&) = delete¶

~Processor()¶: Do not use (needed only for pybind11).

typedef std::shared_ptr<const Processor> OpenColorIO_v2_6dev::ConstProcessorRcPtr¶

typedef std::shared_ptr<Processor> OpenColorIO_v2_6dev::ProcessorRcPtr¶

CPUProcessor¶

class PyOpenColorIO.CPUProcessor¶

CPUProcessor(*args, **kwargs)¶

apply(*args, **kwargs)¶

Overloaded function.

apply(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, imgDesc: PyOpenColorIO.PyOpenColorIO.ImageDesc) -> None

Apply to an image with any kind of channel ordering while respecting the input and output bit-depths. Image values are modified in place.

Note

The GIL is released during processing, freeing up Python to execute other threads concurrently.

Note

For large images, applyRGB or applyRGBA are preferred for processing a NumPy array. The Python ImageDesc implementation requires copying all values (once) in order to own the underlying pointer. The dedicated packed apply* methods utilize ImageDesc on the C++ side so avoid the copy.

apply(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, srcImgDesc: PyOpenColorIO.PyOpenColorIO.ImageDesc, dstImgDesc: PyOpenColorIO.PyOpenColorIO.ImageDesc) -> None

Apply to an image with any kind of channel ordering while respecting the input and output bit-depths. Modified srcImgDesc image values are written to the dstImgDesc image, leaving srcImgDesc unchanged.

Note

The GIL is released during processing, freeing up Python to execute other threads concurrently.

Note

applyRGB(*args, **kwargs)¶

Overloaded function.

applyRGB(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, data: typing_extensions.Buffer) -> None

Apply to a packed RGB array adhering to the Python buffer protocol. This will typically be a NumPy array. Input and output bit-depths are respected but must match. Any array size or shape is supported as long as the flattened array size is divisible by 3. Array values are modified in place.

Note

This differs from the C++ implementation which only applies to a single pixel. This method uses a PackedImageDesc under the hood to apply to an entire image at once. The GIL is released during processing, freeing up Python to execute other threads concurrently.

applyRGB(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, data: collections.abc.Sequence[typing.SupportsFloat]) -> list[float]

Apply to a packed RGB list of float values. Any size is supported as long as the list length is divisible by 3. A new list with processed float values is returned, leaving the input list unchanged.

Note

For large images, a NumPy array should be preferred over a list. List values are copied on input and output, where an array is modified in place.

applyRGBA(*args, **kwargs)¶

Overloaded function.

applyRGBA(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, data: typing_extensions.Buffer) -> None

Apply to a packed RGBA array adhering to the Python buffer protocol. This will typically be a NumPy array. Input and output bit-depths are respected but must match. Any array size or shape is supported as long as the flattened array size is divisible by 4. Array values are modified in place.

Note

applyRGBA(self: PyOpenColorIO.PyOpenColorIO.CPUProcessor, data: collections.abc.Sequence[typing.SupportsFloat]) -> list[float]

Apply to a packed RGBA list of float values. Any size is supported as long as the list length is divisible by 4. A new list with processed float values is returned, leaving the input list unchanged.

Note

For large images, a NumPy array should be preferred over a list. List values are copied on input and output, where an array is modified in place.

getCacheID() → str¶

getDynamicProperty(type: PyOpenColorIO.PyOpenColorIO.DynamicPropertyType) → PyOpenColorIO.PyOpenColorIO.DynamicProperty¶

getInputBitDepth() → PyOpenColorIO.PyOpenColorIO.BitDepth¶

getOutputBitDepth() → PyOpenColorIO.PyOpenColorIO.BitDepth¶

hasChannelCrosstalk() → bool¶

hasDynamicProperty(type: PyOpenColorIO.PyOpenColorIO.DynamicPropertyType) → bool¶

isDynamic() → bool¶

isIdentity() → bool¶

isNoOp() → bool¶

class CPUProcessor¶

Public Functions

bool isNoOp() const¶: The in and out bit-depths must be equal for isNoOp to be true.

bool isIdentity() const¶: Equivalent to isNoOp from the underlying Processor, i.e., it ignores in/out bit-depth differences.

bool hasChannelCrosstalk() const¶

const char *getCacheID() const¶

BitDepth getInputBitDepth() const¶: Bit-depth of the input pixel buffer.

BitDepth getOutputBitDepth() const¶: Bit-depth of the output pixel buffer.

DynamicPropertyRcPtr getDynamicProperty(DynamicPropertyType type) const¶: The returned pointer may be used to set the value of any dynamic properties of the requested type. Throws if the requested property is not found. Note that if the processor contains several ops that support the requested property, only one can be dynamic.

Note

The dynamic properties in this object are decoupled from the ones in the Processor it was generated from. For each dynamic property in the Processor, there is one in the CPU processor.

bool hasDynamicProperty(DynamicPropertyType type) const noexcept¶: True if at least one dynamic property of that type exists.

bool isDynamic() const noexcept¶: True if at least one dynamic property of any type exists and is dynamic.

void apply(const ImageDesc &imgDesc) const¶: Apply to an image with any kind of channel ordering while respecting the input and output bit-depths.

void apply(const ImageDesc &srcImgDesc, ImageDesc &dstImgDesc) const¶

void applyRGB(float *pixel) const¶: Apply to a single pixel respecting that the input and output bit-depths be 32-bit float and the image buffer be packed RGB/RGBA.

Note

This is not as efficient as applying to an entire image at once. If you are processing multiple pixels, and have the flexibility, use the above function instead.

void applyRGBA(float *pixel) const¶

CPUProcessor(const CPUProcessor&) = delete¶

CPUProcessor &operator=(const CPUProcessor&) = delete¶

~CPUProcessor()¶: Do not use (needed only for pybind11).

typedef std::shared_ptr<const CPUProcessor> OpenColorIO_v2_6dev::ConstCPUProcessorRcPtr¶

typedef std::shared_ptr<CPUProcessor> OpenColorIO_v2_6dev::CPUProcessorRcPtr¶

GPUProcessor¶

class PyOpenColorIO.GPUProcessor¶

GPUProcessor(*args, **kwargs)¶

extractGpuShaderInfo(shaderDesc: PyOpenColorIO.PyOpenColorIO.GpuShaderDesc) → None¶

getCacheID() → str¶

hasChannelCrosstalk() → bool¶

isNoOp() → bool¶

ProcessorMetadata¶

class PyOpenColorIO.ProcessorMetadata¶

ProcessorMetadata() → None¶

addFile(fileName: str) → None¶

addLook(look: str) → None¶

getFiles() → PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator¶

getLooks() → PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator¶

class PyOpenColorIO.ProcessorMetadata.FileIterator¶

self[arg0: SupportsInt] → str¶

iter(self) → PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.FileIterator¶

len(self) → int¶

next(self) → str¶

class PyOpenColorIO.ProcessorMetadata.LookIterator¶

self[arg0: SupportsInt] → str¶

iter(self) → PyOpenColorIO.PyOpenColorIO.ProcessorMetadata.LookIterator¶

len(self) → int¶

next(self) → str¶