Enums¶

LoggingLevel¶

class PyOpenColorIO.LoggingLevel¶

Members:

LOGGING_LEVEL_NONE :

LOGGING_LEVEL_WARNING :

LOGGING_LEVEL_INFO :

LOGGING_LEVEL_DEBUG :

LOGGING_LEVEL_UNKNOWN :

property name → str¶

LOGGING_LEVEL_DEBUG = <LoggingLevel.LOGGING_LEVEL_DEBUG: 3>¶

LOGGING_LEVEL_INFO = <LoggingLevel.LOGGING_LEVEL_INFO: 2>¶

LOGGING_LEVEL_NONE = <LoggingLevel.LOGGING_LEVEL_NONE: 0>¶

LOGGING_LEVEL_UNKNOWN = <LoggingLevel.LOGGING_LEVEL_UNKNOWN: 255>¶

LOGGING_LEVEL_WARNING = <LoggingLevel.LOGGING_LEVEL_WARNING: 1>¶

Conversions: LoggingLevel

ReferenceSpaceType¶

class PyOpenColorIO.ReferenceSpaceType¶

OCIO does not mandate the image state of the main reference space and it is not required to be scene-referred. This enum is used in connection with the display color space and view transform features which do assume that the main reference space is scene-referred and the display reference space is display-referred. If a config used a non-scene-referred reference space, presumably it would not use either display color spaces or view transforms, so this enum becomes irrelevant.

Members:

REFERENCE_SPACE_SCENE : the main scene reference space

REFERENCE_SPACE_DISPLAY : the reference space for display color spaces

property name → str¶

REFERENCE_SPACE_DISPLAY = <ReferenceSpaceType.REFERENCE_SPACE_DISPLAY: 1>¶

REFERENCE_SPACE_SCENE = <ReferenceSpaceType.REFERENCE_SPACE_SCENE: 0>¶

SearchReferenceSpaceType¶

class PyOpenColorIO.SearchReferenceSpaceType¶

Members:

SEARCH_REFERENCE_SPACE_SCENE :

SEARCH_REFERENCE_SPACE_DISPLAY :

SEARCH_REFERENCE_SPACE_ALL :

property name → str¶

SEARCH_REFERENCE_SPACE_ALL = <SearchReferenceSpaceType.SEARCH_REFERENCE_SPACE_ALL: 2>¶

SEARCH_REFERENCE_SPACE_DISPLAY = <SearchReferenceSpaceType.SEARCH_REFERENCE_SPACE_DISPLAY: 1>¶

SEARCH_REFERENCE_SPACE_SCENE = <SearchReferenceSpaceType.SEARCH_REFERENCE_SPACE_SCENE: 0>¶

NamedTransformVisibility¶

class PyOpenColorIO.NamedTransformVisibility¶

Members:

NAMEDTRANSFORM_ACTIVE :

NAMEDTRANSFORM_INACTIVE :

NAMEDTRANSFORM_ALL :

property name → str¶

NAMEDTRANSFORM_ACTIVE = <NamedTransformVisibility.NAMEDTRANSFORM_ACTIVE: 0>¶

NAMEDTRANSFORM_ALL = <NamedTransformVisibility.NAMEDTRANSFORM_ALL: 2>¶

NAMEDTRANSFORM_INACTIVE = <NamedTransformVisibility.NAMEDTRANSFORM_INACTIVE: 1>¶

ColorSpaceVisibility¶

class PyOpenColorIO.ColorSpaceVisibility¶

Members:

COLORSPACE_ACTIVE :

COLORSPACE_INACTIVE :

COLORSPACE_ALL :

property name → str¶

COLORSPACE_ACTIVE = <ColorSpaceVisibility.COLORSPACE_ACTIVE: 0>¶

COLORSPACE_ALL = <ColorSpaceVisibility.COLORSPACE_ALL: 2>¶

COLORSPACE_INACTIVE = <ColorSpaceVisibility.COLORSPACE_INACTIVE: 1>¶

ViewType¶

class PyOpenColorIO.ViewType¶

Members:

VIEW_SHARED :

VIEW_DISPLAY_DEFINED :

property name → str¶

VIEW_DISPLAY_DEFINED = <ViewType.VIEW_DISPLAY_DEFINED: 1>¶

VIEW_SHARED = <ViewType.VIEW_SHARED: 0>¶

ColorSpaceDirection¶

class PyOpenColorIO.ColorSpaceDirection¶

Members:

COLORSPACE_DIR_TO_REFERENCE :

COLORSPACE_DIR_FROM_REFERENCE :

property name → str¶

COLORSPACE_DIR_FROM_REFERENCE = <ColorSpaceDirection.COLORSPACE_DIR_FROM_REFERENCE: 1>¶

COLORSPACE_DIR_TO_REFERENCE = <ColorSpaceDirection.COLORSPACE_DIR_TO_REFERENCE: 0>¶

Conversions: conversion_color_space_direction

ViewTransformDirection¶

class PyOpenColorIO.ViewTransformDirection¶

Members:

VIEWTRANSFORM_DIR_TO_REFERENCE :

VIEWTRANSFORM_DIR_FROM_REFERENCE :

property name → str¶

VIEWTRANSFORM_DIR_FROM_REFERENCE = <ViewTransformDirection.VIEWTRANSFORM_DIR_FROM_REFERENCE: 1>¶

VIEWTRANSFORM_DIR_TO_REFERENCE = <ViewTransformDirection.VIEWTRANSFORM_DIR_TO_REFERENCE: 0>¶

TransformDirection¶

class PyOpenColorIO.TransformDirection¶

Members:

TRANSFORM_DIR_FORWARD :

TRANSFORM_DIR_INVERSE :

property name → str¶

TRANSFORM_DIR_FORWARD = <TransformDirection.TRANSFORM_DIR_FORWARD: 0>¶

TRANSFORM_DIR_INVERSE = <TransformDirection.TRANSFORM_DIR_INVERSE: 1>¶

Conversions: TransformDirection

TransformType¶

class PyOpenColorIO.TransformType¶

Members:

TRANSFORM_TYPE_ALLOCATION :

TRANSFORM_TYPE_BUILTIN :

TRANSFORM_TYPE_CDL :

TRANSFORM_TYPE_COLORSPACE :

TRANSFORM_TYPE_DISPLAY_VIEW :

TRANSFORM_TYPE_EXPONENT :

TRANSFORM_TYPE_EXPONENT_WITH_LINEAR :

TRANSFORM_TYPE_EXPOSURE_CONTRAST :

TRANSFORM_TYPE_FILE :

TRANSFORM_TYPE_FIXED_FUNCTION :

TRANSFORM_TYPE_GRADING_PRIMARY :

TRANSFORM_TYPE_GRADING_RGB_CURVE :

TRANSFORM_TYPE_GRADING_TONE :

TRANSFORM_TYPE_GROUP :

TRANSFORM_TYPE_LOG_AFFINE :

TRANSFORM_TYPE_LOG_CAMERA :

TRANSFORM_TYPE_LOG :

TRANSFORM_TYPE_LOOK :

TRANSFORM_TYPE_LUT1D :

TRANSFORM_TYPE_LUT3D :

TRANSFORM_TYPE_MATRIX :

TRANSFORM_TYPE_RANGE :

property name → str¶

TRANSFORM_TYPE_ALLOCATION = <TransformType.TRANSFORM_TYPE_ALLOCATION: 0>¶

TRANSFORM_TYPE_BUILTIN = <TransformType.TRANSFORM_TYPE_BUILTIN: 1>¶

TRANSFORM_TYPE_CDL = <TransformType.TRANSFORM_TYPE_CDL: 2>¶

TRANSFORM_TYPE_COLORSPACE = <TransformType.TRANSFORM_TYPE_COLORSPACE: 3>¶

TRANSFORM_TYPE_DISPLAY_VIEW = <TransformType.TRANSFORM_TYPE_DISPLAY_VIEW: 4>¶

TRANSFORM_TYPE_EXPONENT = <TransformType.TRANSFORM_TYPE_EXPONENT: 5>¶

TRANSFORM_TYPE_EXPONENT_WITH_LINEAR = <TransformType.TRANSFORM_TYPE_EXPONENT_WITH_LINEAR: 6>¶

TRANSFORM_TYPE_EXPOSURE_CONTRAST = <TransformType.TRANSFORM_TYPE_EXPOSURE_CONTRAST: 7>¶

TRANSFORM_TYPE_FILE = <TransformType.TRANSFORM_TYPE_FILE: 8>¶

TRANSFORM_TYPE_FIXED_FUNCTION = <TransformType.TRANSFORM_TYPE_FIXED_FUNCTION: 9>¶

TRANSFORM_TYPE_GRADING_PRIMARY = <TransformType.TRANSFORM_TYPE_GRADING_PRIMARY: 10>¶

TRANSFORM_TYPE_GRADING_RGB_CURVE = <TransformType.TRANSFORM_TYPE_GRADING_RGB_CURVE: 11>¶

TRANSFORM_TYPE_GRADING_TONE = <TransformType.TRANSFORM_TYPE_GRADING_TONE: 12>¶

TRANSFORM_TYPE_GROUP = <TransformType.TRANSFORM_TYPE_GROUP: 13>¶

TRANSFORM_TYPE_LOG = <TransformType.TRANSFORM_TYPE_LOG: 16>¶

TRANSFORM_TYPE_LOG_AFFINE = <TransformType.TRANSFORM_TYPE_LOG_AFFINE: 14>¶

TRANSFORM_TYPE_LOG_CAMERA = <TransformType.TRANSFORM_TYPE_LOG_CAMERA: 15>¶

TRANSFORM_TYPE_LOOK = <TransformType.TRANSFORM_TYPE_LOOK: 17>¶

TRANSFORM_TYPE_LUT1D = <TransformType.TRANSFORM_TYPE_LUT1D: 18>¶

TRANSFORM_TYPE_LUT3D = <TransformType.TRANSFORM_TYPE_LUT3D: 19>¶

TRANSFORM_TYPE_MATRIX = <TransformType.TRANSFORM_TYPE_MATRIX: 20>¶

TRANSFORM_TYPE_RANGE = <TransformType.TRANSFORM_TYPE_RANGE: 21>¶

Interpolation¶

class PyOpenColorIO.Interpolation¶

Specify the interpolation type to use If the specified interpolation type is not supported in the requested context (for example, using tetrahedral interpolationon 1D LUTs) an exception will be thrown.

INTERP_DEFAULT will choose the default interpolation type for the requested context:

1D LUT INTERP_DEFAULT: LINEAR 3D LUT INTERP_DEFAULT: LINEAR

INTERP_BEST will choose the best interpolation type for the requested context:

1D LUT INTERP_BEST: LINEAR 3D LUT INTERP_BEST: TETRAHEDRAL

Note: INTERP_BEST and INTERP_DEFAULT are subject to change in minor releases, so if you care about locking off on a specific interpolation type, we’d recommend directly specifying it.

Members:

INTERP_UNKNOWN :

INTERP_NEAREST : nearest neighbor

INTERP_LINEAR : linear interpolation (trilinear for Lut3D)

INTERP_TETRAHEDRAL : tetrahedral interpolation (Lut3D only)

INTERP_CUBIC : cubic interpolation (not supported)

INTERP_DEFAULT : the default interpolation type

INTERP_BEST : the ‘best’ suitable interpolation type

property name → str¶

INTERP_BEST = <Interpolation.INTERP_BEST: 255>¶

INTERP_CUBIC = <Interpolation.INTERP_CUBIC: 4>¶

INTERP_DEFAULT = <Interpolation.INTERP_DEFAULT: 254>¶

INTERP_LINEAR = <Interpolation.INTERP_LINEAR: 2>¶

INTERP_NEAREST = <Interpolation.INTERP_NEAREST: 1>¶

INTERP_TETRAHEDRAL = <Interpolation.INTERP_TETRAHEDRAL: 3>¶

INTERP_UNKNOWN = <Interpolation.INTERP_UNKNOWN: 0>¶

Conversions: Interpolation

BitDepth¶

class PyOpenColorIO.BitDepth¶

Used in a configuration file to indicate the bit-depth of a color space, and by the Processor to specify the input and output bit-depths of images to process. Note that Processor only supports: UINT8, UINT10, UINT12, UINT16, F16 and F32.

Members:

BIT_DEPTH_UNKNOWN :

BIT_DEPTH_UINT8 :

BIT_DEPTH_UINT10 :

BIT_DEPTH_UINT12 :

BIT_DEPTH_UINT14 :

BIT_DEPTH_UINT16 :

BIT_DEPTH_UINT32 :

BIT_DEPTH_F16 :

BIT_DEPTH_F32 :

property name → str¶

BIT_DEPTH_F16 = <BitDepth.BIT_DEPTH_F16: 7>¶

BIT_DEPTH_F32 = <BitDepth.BIT_DEPTH_F32: 8>¶

BIT_DEPTH_UINT10 = <BitDepth.BIT_DEPTH_UINT10: 2>¶

BIT_DEPTH_UINT12 = <BitDepth.BIT_DEPTH_UINT12: 3>¶

BIT_DEPTH_UINT14 = <BitDepth.BIT_DEPTH_UINT14: 4>¶

BIT_DEPTH_UINT16 = <BitDepth.BIT_DEPTH_UINT16: 5>¶

BIT_DEPTH_UINT32 = <BitDepth.BIT_DEPTH_UINT32: 6>¶

BIT_DEPTH_UINT8 = <BitDepth.BIT_DEPTH_UINT8: 1>¶

BIT_DEPTH_UNKNOWN = <BitDepth.BIT_DEPTH_UNKNOWN: 0>¶

Conversions: BitDepth

Lut1DHueAdjust¶

class PyOpenColorIO.Lut1DHueAdjust¶

Used by :cpp:class`:ref:Lut1DTransform` to control optional hue restoration algorithm.

Members:

HUE_NONE : No adjustment.

HUE_DW3 : Algorithm used in ACES Output Transforms through v0.7.

HUE_WYPN : Weighted Yellow Power Norm – NOT IMPLEMENTED YET.

property name → str¶

HUE_DW3 = <Lut1DHueAdjust.HUE_DW3: 1>¶

HUE_NONE = <Lut1DHueAdjust.HUE_NONE: 0>¶

HUE_WYPN = <Lut1DHueAdjust.HUE_WYPN: 2>¶

enum OpenColorIO_v2_2dev::Lut1DHueAdjust¶

Used by :cpp:classLut1DTransform to control optional hue restoration algorithm.

Values:

enumerator HUE_NONE¶: No adjustment.

enumerator HUE_DW3¶: Algorithm used in ACES Output Transforms through v0.7.

enumerator HUE_WYPN¶: Weighted Yellow Power Norm — NOT IMPLEMENTED YET.

ChannelOrdering¶

class PyOpenColorIO.ChannelOrdering¶

Used by PackedImageDesc to indicate the channel ordering of the image to process.

Members:

CHANNEL_ORDERING_RGBA :

CHANNEL_ORDERING_BGRA :

CHANNEL_ORDERING_ABGR :

CHANNEL_ORDERING_RGB :

CHANNEL_ORDERING_BGR :

property name → str¶

CHANNEL_ORDERING_ABGR = <ChannelOrdering.CHANNEL_ORDERING_ABGR: 2>¶

CHANNEL_ORDERING_BGR = <ChannelOrdering.CHANNEL_ORDERING_BGR: 4>¶

CHANNEL_ORDERING_BGRA = <ChannelOrdering.CHANNEL_ORDERING_BGRA: 1>¶

CHANNEL_ORDERING_RGB = <ChannelOrdering.CHANNEL_ORDERING_RGB: 3>¶

CHANNEL_ORDERING_RGBA = <ChannelOrdering.CHANNEL_ORDERING_RGBA: 0>¶

Allocation¶

class PyOpenColorIO.Allocation¶

Members:

ALLOCATION_UNKNOWN :

ALLOCATION_UNIFORM :

ALLOCATION_LG2 :

property name → str¶

ALLOCATION_LG2 = <Allocation.ALLOCATION_LG2: 2>¶

ALLOCATION_UNIFORM = <Allocation.ALLOCATION_UNIFORM: 1>¶

ALLOCATION_UNKNOWN = <Allocation.ALLOCATION_UNKNOWN: 0>¶

Conversions: Allocation

GpuLanguage¶

class PyOpenColorIO.GpuLanguage¶

Used when there is a choice of hardware shader language.

Members:

GPU_LANGUAGE_CG : Nvidia Cg shader.

GPU_LANGUAGE_GLSL_1_2 : OpenGL Shading Language.

GPU_LANGUAGE_GLSL_1_3 : OpenGL Shading Language.

GPU_LANGUAGE_GLSL_4_0 : OpenGL Shading Language.

GPU_LANGUAGE_HLSL_DX11 : DirectX Shading Language.

property name → str¶

GPU_LANGUAGE_CG = <GpuLanguage.GPU_LANGUAGE_CG: 0>¶

GPU_LANGUAGE_GLSL_1_2 = <GpuLanguage.GPU_LANGUAGE_GLSL_1_2: 1>¶

GPU_LANGUAGE_GLSL_1_3 = <GpuLanguage.GPU_LANGUAGE_GLSL_1_3: 2>¶

GPU_LANGUAGE_GLSL_4_0 = <GpuLanguage.GPU_LANGUAGE_GLSL_4_0: 3>¶

GPU_LANGUAGE_HLSL_DX11 = <GpuLanguage.GPU_LANGUAGE_HLSL_DX11: 4>¶

Conversions: GpuLanguage

EnvironmentMode¶

class PyOpenColorIO.EnvironmentMode¶

Members:

ENV_ENVIRONMENT_UNKNOWN :

ENV_ENVIRONMENT_LOAD_PREDEFINED :

ENV_ENVIRONMENT_LOAD_ALL :

property name → str¶

ENV_ENVIRONMENT_LOAD_ALL = <EnvironmentMode.ENV_ENVIRONMENT_LOAD_ALL: 2>¶

ENV_ENVIRONMENT_LOAD_PREDEFINED = <EnvironmentMode.ENV_ENVIRONMENT_LOAD_PREDEFINED: 1>¶

ENV_ENVIRONMENT_UNKNOWN = <EnvironmentMode.ENV_ENVIRONMENT_UNKNOWN: 0>¶

Conversions: EnvironmentMode

RangeStyle¶

class PyOpenColorIO.RangeStyle¶

A RangeTransform may be set to clamp the values, or not.

Members:

RANGE_NO_CLAMP :

RANGE_CLAMP :

property name → str¶

RANGE_CLAMP = <RangeStyle.RANGE_CLAMP: 1>¶

RANGE_NO_CLAMP = <RangeStyle.RANGE_NO_CLAMP: 0>¶

Conversions: RangeStyle

FixedFunctionStyle¶

class PyOpenColorIO.FixedFunctionStyle¶

Enumeration of the :ref:`FixedFunctionTransform` transform algorithms.

Members:

FIXED_FUNCTION_ACES_RED_MOD_03 : Red modifier (ACES 0.3/0.7)

FIXED_FUNCTION_ACES_RED_MOD_10 : Red modifier (ACES 1.0)

FIXED_FUNCTION_ACES_GLOW_03 : Glow function (ACES 0.3/0.7)

FIXED_FUNCTION_ACES_GLOW_10 : Glow function (ACES 1.0)

FIXED_FUNCTION_ACES_DARK_TO_DIM_10 : Dark to dim surround correction (ACES 1.0)

FIXED_FUNCTION_REC2100_SURROUND : Rec.2100 surround correction (takes one double for the gamma param)

FIXED_FUNCTION_RGB_TO_HSV : Classic RGB to HSV function.

FIXED_FUNCTION_XYZ_TO_xyY : CIE XYZ to 1931 xy chromaticity coordinates.

FIXED_FUNCTION_XYZ_TO_uvY : CIE XYZ to 1976 u’v’ chromaticity coordinates.

FIXED_FUNCTION_XYZ_TO_LUV : CIE XYZ to 1976 CIELUV colour space (D65 white)

FIXED_FUNCTION_ACES_GAMUTMAP_02 : ACES 0.2 Gamut clamping algorithm – NOT IMPLEMENTED YET.

FIXED_FUNCTION_ACES_GAMUTMAP_07 : ACES 0.7 Gamut clamping algorithm – NOT IMPLEMENTED YET.

FIXED_FUNCTION_ACES_GAMUTMAP_13 : ACES 1.3 Gamut mapping algorithm.

property name → str¶

FIXED_FUNCTION_ACES_DARK_TO_DIM_10 = <FixedFunctionStyle.FIXED_FUNCTION_ACES_DARK_TO_DIM_10: 4>¶

FIXED_FUNCTION_ACES_GAMUTMAP_02 = <FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUTMAP_02: 10>¶

FIXED_FUNCTION_ACES_GAMUTMAP_07 = <FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUTMAP_07: 11>¶

FIXED_FUNCTION_ACES_GAMUTMAP_13 = <FixedFunctionStyle.FIXED_FUNCTION_ACES_GAMUTMAP_13: 12>¶

FIXED_FUNCTION_ACES_GLOW_03 = <FixedFunctionStyle.FIXED_FUNCTION_ACES_GLOW_03: 2>¶

FIXED_FUNCTION_ACES_GLOW_10 = <FixedFunctionStyle.FIXED_FUNCTION_ACES_GLOW_10: 3>¶

FIXED_FUNCTION_ACES_RED_MOD_03 = <FixedFunctionStyle.FIXED_FUNCTION_ACES_RED_MOD_03: 0>¶

FIXED_FUNCTION_ACES_RED_MOD_10 = <FixedFunctionStyle.FIXED_FUNCTION_ACES_RED_MOD_10: 1>¶

FIXED_FUNCTION_REC2100_SURROUND = <FixedFunctionStyle.FIXED_FUNCTION_REC2100_SURROUND: 5>¶

FIXED_FUNCTION_RGB_TO_HSV = <FixedFunctionStyle.FIXED_FUNCTION_RGB_TO_HSV: 6>¶

FIXED_FUNCTION_XYZ_TO_LUV = <FixedFunctionStyle.FIXED_FUNCTION_XYZ_TO_LUV: 9>¶

FIXED_FUNCTION_XYZ_TO_uvY = <FixedFunctionStyle.FIXED_FUNCTION_XYZ_TO_uvY: 8>¶

FIXED_FUNCTION_XYZ_TO_xyY = <FixedFunctionStyle.FIXED_FUNCTION_XYZ_TO_xyY: 7>¶

enum OpenColorIO_v2_2dev::FixedFunctionStyle¶

Enumeration of the :cpp:class:FixedFunctionTransform transform algorithms.

Values:

enumerator FIXED_FUNCTION_ACES_RED_MOD_03¶: Red modifier (ACES 0.3/0.7)

enumerator FIXED_FUNCTION_ACES_RED_MOD_10¶: Red modifier (ACES 1.0)

enumerator FIXED_FUNCTION_ACES_GLOW_03¶: Glow function (ACES 0.3/0.7)

enumerator FIXED_FUNCTION_ACES_GLOW_10¶: Glow function (ACES 1.0)

enumerator FIXED_FUNCTION_ACES_DARK_TO_DIM_10¶: Dark to dim surround correction (ACES 1.0)

enumerator FIXED_FUNCTION_REC2100_SURROUND¶: Rec.2100 surround correction (takes one double for the gamma param)

enumerator FIXED_FUNCTION_RGB_TO_HSV¶: Classic RGB to HSV function.

enumerator FIXED_FUNCTION_XYZ_TO_xyY¶: CIE XYZ to 1931 xy chromaticity coordinates.

enumerator FIXED_FUNCTION_XYZ_TO_uvY¶: CIE XYZ to 1976 u’v’ chromaticity coordinates.

enumerator FIXED_FUNCTION_XYZ_TO_LUV¶: CIE XYZ to 1976 CIELUV colour space (D65 white)

enumerator FIXED_FUNCTION_ACES_GAMUTMAP_02¶: ACES 0.2 Gamut clamping algorithm — NOT IMPLEMENTED YET.

enumerator FIXED_FUNCTION_ACES_GAMUTMAP_07¶: ACES 0.7 Gamut clamping algorithm — NOT IMPLEMENTED YET.

enumerator FIXED_FUNCTION_ACES_GAMUT_COMP_13¶: ACES 1.3 Parametric Gamut Compression (expects ACEScg values)

Conversions: FixedFunctionStyle

ExposureContrastStyle¶

class PyOpenColorIO.ExposureContrastStyle¶

Enumeration of the :ref:`ExposureContrastTransform` transform algorithms.

Members:

EXPOSURE_CONTRAST_LINEAR : E/C to be applied to a linear space image.

EXPOSURE_CONTRAST_VIDEO : E/C to be applied to a video space image.

EXPOSURE_CONTRAST_LOGARITHMIC : E/C to be applied to a log space image.

property name → str¶

EXPOSURE_CONTRAST_LINEAR = <ExposureContrastStyle.EXPOSURE_CONTRAST_LINEAR: 0>¶

EXPOSURE_CONTRAST_LOGARITHMIC = <ExposureContrastStyle.EXPOSURE_CONTRAST_LOGARITHMIC: 2>¶

EXPOSURE_CONTRAST_VIDEO = <ExposureContrastStyle.EXPOSURE_CONTRAST_VIDEO: 1>¶

enum OpenColorIO_v2_2dev::ExposureContrastStyle¶

Enumeration of the :cpp:class:ExposureContrastTransform transform algorithms.

Values:

enumerator EXPOSURE_CONTRAST_LINEAR¶: E/C to be applied to a linear space image.

enumerator EXPOSURE_CONTRAST_VIDEO¶: E/C to be applied to a video space image.

enumerator EXPOSURE_CONTRAST_LOGARITHMIC¶: E/C to be applied to a log space image.

Conversions: ExposureContrastStyle

CDLStyle¶

class PyOpenColorIO.CDLStyle¶

Members:

CDL_ASC : ASC CDL specification v1.2.

CDL_NO_CLAMP : CDL that does not clamp.

CDL_TRANSFORM_DEFAULT :

property name → str¶

CDL_ASC = <CDLStyle.CDL_ASC: 0>¶

CDL_NO_CLAMP = <CDLStyle.CDL_NO_CLAMP: 1>¶

CDL_TRANSFORM_DEFAULT = <CDLStyle.CDL_NO_CLAMP: 1>¶

enum OpenColorIO_v2_2dev::CDLStyle¶

Enumeration of the :cpp:class:CDLTransform transform algorithms.

Note

The default for reading .cc/.ccc/.cdl files, config file YAML, and CDLTransform is no-clamp, since that is what is primarily desired in VFX. However, the CLF format default is ASC.

Values:

enumerator CDL_ASC¶: ASC CDL specification v1.2.

enumerator CDL_NO_CLAMP¶: CDL that does not clamp.

enumerator CDL_TRANSFORM_DEFAULT¶

Conversions: CDLStyle

NegativeStyle¶

class PyOpenColorIO.NegativeStyle¶

Negative values handling style for ExponentTransform and ExponentWithLinearTransform transform algorithms.

Members:

NEGATIVE_CLAMP : Clamp negative values.

NEGATIVE_MIRROR : Positive curve is rotated 180 degrees around the origin to handle negatives.

NEGATIVE_PASS_THRU : Negative values are passed through unchanged.

NEGATIVE_LINEAR : Linearly extrapolate the curve for negative values.

property name → str¶

NEGATIVE_CLAMP = <NegativeStyle.NEGATIVE_CLAMP: 0>¶

NEGATIVE_LINEAR = <NegativeStyle.NEGATIVE_LINEAR: 3>¶

NEGATIVE_MIRROR = <NegativeStyle.NEGATIVE_MIRROR: 1>¶

NEGATIVE_PASS_THRU = <NegativeStyle.NEGATIVE_PASS_THRU: 2>¶

Conversions: NegativeStyle

GradingStyle¶

class PyOpenColorIO.GradingStyle¶

Styles for grading transforms.

Members:

GRADING_LOG : Algorithms for Logarithmic color spaces.

GRADING_LIN : Algorithms for Scene Linear color spaces.

GRADING_VIDEO : Algorithms for Video color spaces.

property name → str¶

GRADING_LIN = <GradingStyle.GRADING_LIN: 1>¶

GRADING_LOG = <GradingStyle.GRADING_LOG: 0>¶

GRADING_VIDEO = <GradingStyle.GRADING_VIDEO: 2>¶

Conversions: GradingStyle

DynamicPropertyType¶

class PyOpenColorIO.DynamicPropertyType¶

Types for dynamic properties.

Members:

DYNAMIC_PROPERTY_EXPOSURE : Image exposure value (double floating point value)

DYNAMIC_PROPERTY_CONTRAST : Image contrast value (double floating point value)

DYNAMIC_PROPERTY_GAMMA : Image gamma value (double floating point value)

DYNAMIC_PROPERTY_GRADING_PRIMARY : Used by GradingPrimaryTransform.

DYNAMIC_PROPERTY_GRADING_RGBCURVE : Used by GradingRGBCurveTransform.

DYNAMIC_PROPERTY_GRADING_TONE : Used by GradingToneTransform.

property name → str¶

DYNAMIC_PROPERTY_CONTRAST = <DynamicPropertyType.DYNAMIC_PROPERTY_CONTRAST: 1>¶

DYNAMIC_PROPERTY_EXPOSURE = <DynamicPropertyType.DYNAMIC_PROPERTY_EXPOSURE: 0>¶

DYNAMIC_PROPERTY_GAMMA = <DynamicPropertyType.DYNAMIC_PROPERTY_GAMMA: 2>¶

DYNAMIC_PROPERTY_GRADING_PRIMARY = <DynamicPropertyType.DYNAMIC_PROPERTY_GRADING_PRIMARY: 3>¶

DYNAMIC_PROPERTY_GRADING_RGBCURVE = <DynamicPropertyType.DYNAMIC_PROPERTY_GRADING_RGBCURVE: 4>¶

DYNAMIC_PROPERTY_GRADING_TONE = <DynamicPropertyType.DYNAMIC_PROPERTY_GRADING_TONE: 5>¶

RGBCurveType¶

class PyOpenColorIO.RGBCurveType¶

Types for GradingRGBCurve.

Members:

RGB_RED :

RGB_GREEN :

RGB_BLUE :

RGB_MASTER :

RGB_NUM_CURVES :

property name → str¶

RGB_BLUE = <RGBCurveType.RGB_BLUE: 2>¶

RGB_GREEN = <RGBCurveType.RGB_GREEN: 1>¶

RGB_MASTER = <RGBCurveType.RGB_MASTER: 3>¶

RGB_NUM_CURVES = <RGBCurveType.RGB_NUM_CURVES: 4>¶

RGB_RED = <RGBCurveType.RGB_RED: 0>¶

UniformDataType¶

class PyOpenColorIO.UniformDataType¶

Types for uniform data.

Members:

UNIFORM_DOUBLE :

UNIFORM_BOOL :

UNIFORM_FLOAT3 : Array of 3 floats.

UNIFORM_VECTOR_FLOAT : Vector of floats (size is set by uniform).

UNIFORM_VECTOR_INT : Vector of int pairs (size is set by uniform).

UNIFORM_UNKNOWN :

property name → str¶

UNIFORM_BOOL = <UniformDataType.UNIFORM_BOOL: 1>¶

UNIFORM_DOUBLE = <UniformDataType.UNIFORM_DOUBLE: 0>¶

UNIFORM_FLOAT3 = <UniformDataType.UNIFORM_FLOAT3: 2>¶

UNIFORM_UNKNOWN = <UniformDataType.UNIFORM_UNKNOWN: 5>¶

UNIFORM_VECTOR_FLOAT = <UniformDataType.UNIFORM_VECTOR_FLOAT: 3>¶

UNIFORM_VECTOR_INT = <UniformDataType.UNIFORM_VECTOR_INT: 4>¶

OptimizationFlags¶

class PyOpenColorIO.OptimizationFlags¶

Provides control over how the ops in a Processor are combined in order to improve performance.

Members:

OPTIMIZATION_NONE : Do not optimize.

OPTIMIZATION_IDENTITY : Replace identity ops (other than gamma).

OPTIMIZATION_IDENTITY_GAMMA : Replace identity gamma ops.

OPTIMIZATION_PAIR_IDENTITY_CDL : Replace a pair of ops where one is the inverse of the other.

OPTIMIZATION_PAIR_IDENTITY_EXPOSURE_CONTRAST :

OPTIMIZATION_PAIR_IDENTITY_FIXED_FUNCTION :

OPTIMIZATION_PAIR_IDENTITY_GAMMA :

OPTIMIZATION_PAIR_IDENTITY_LUT1D :

OPTIMIZATION_PAIR_IDENTITY_LUT3D :

OPTIMIZATION_PAIR_IDENTITY_LOG :

OPTIMIZATION_PAIR_IDENTITY_GRADING :

OPTIMIZATION_COMP_EXPONENT : Compose a pair of ops into a single op.

OPTIMIZATION_COMP_GAMMA :

OPTIMIZATION_COMP_MATRIX :

OPTIMIZATION_COMP_LUT1D :

OPTIMIZATION_COMP_LUT3D :

OPTIMIZATION_COMP_RANGE :

OPTIMIZATION_COMP_SEPARABLE_PREFIX : For integer and half bit-depths only, replace separable ops (i.e. no channel crosstalk ops) by a single 1D LUT of input bit-depth domain.

OPTIMIZATION_LUT_INV_FAST : Implement inverse Lut1D and Lut3D evaluations using a a forward LUT (faster but less accurate). Note that GPU evals always do FAST.

OPTIMIZATION_FAST_LOG_EXP_POW :

OPTIMIZATION_SIMPLIFY_OPS :

OPTIMIZATION_NO_DYNAMIC_PROPERTIES : Turn off dynamic control of any ops that offer adjustment of parameter values after finalization (e.g. ExposureContrast).

OPTIMIZATION_ALL : Apply all possible optimizations.

OPTIMIZATION_LOSSLESS :

OPTIMIZATION_VERY_GOOD :

OPTIMIZATION_GOOD :

OPTIMIZATION_DRAFT : For quite lossy optimizations.

OPTIMIZATION_DEFAULT :

property name → str¶

OPTIMIZATION_ALL = <OptimizationFlags.OPTIMIZATION_ALL: 4294967295>¶

OPTIMIZATION_COMP_EXPONENT = <OptimizationFlags.OPTIMIZATION_COMP_EXPONENT: 262144>¶

OPTIMIZATION_COMP_GAMMA = <OptimizationFlags.OPTIMIZATION_COMP_GAMMA: 524288>¶

OPTIMIZATION_COMP_LUT1D = <OptimizationFlags.OPTIMIZATION_COMP_LUT1D: 2097152>¶

OPTIMIZATION_COMP_LUT3D = <OptimizationFlags.OPTIMIZATION_COMP_LUT3D: 4194304>¶

OPTIMIZATION_COMP_MATRIX = <OptimizationFlags.OPTIMIZATION_COMP_MATRIX: 1048576>¶

OPTIMIZATION_COMP_RANGE = <OptimizationFlags.OPTIMIZATION_COMP_RANGE: 8388608>¶

OPTIMIZATION_COMP_SEPARABLE_PREFIX = <OptimizationFlags.OPTIMIZATION_COMP_SEPARABLE_PREFIX: 16777216>¶

OPTIMIZATION_DEFAULT = <OptimizationFlags.OPTIMIZATION_VERY_GOOD: 263995331>¶

OPTIMIZATION_DRAFT = <OptimizationFlags.OPTIMIZATION_ALL: 4294967295>¶

OPTIMIZATION_FAST_LOG_EXP_POW = <OptimizationFlags.OPTIMIZATION_FAST_LOG_EXP_POW: 67108864>¶

OPTIMIZATION_GOOD = <OptimizationFlags.OPTIMIZATION_GOOD: 268189635>¶

OPTIMIZATION_IDENTITY = <OptimizationFlags.OPTIMIZATION_IDENTITY: 1>¶

OPTIMIZATION_IDENTITY_GAMMA = <OptimizationFlags.OPTIMIZATION_IDENTITY_GAMMA: 2>¶

OPTIMIZATION_LOSSLESS = <OptimizationFlags.OPTIMIZATION_LOSSLESS: 144457667>¶

OPTIMIZATION_LUT_INV_FAST = <OptimizationFlags.OPTIMIZATION_LUT_INV_FAST: 33554432>¶

OPTIMIZATION_NONE = <OptimizationFlags.OPTIMIZATION_NONE: 0>¶

OPTIMIZATION_NO_DYNAMIC_PROPERTIES = <OptimizationFlags.OPTIMIZATION_NO_DYNAMIC_PROPERTIES: 268435456>¶

OPTIMIZATION_PAIR_IDENTITY_CDL = <OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_CDL: 64>¶

OPTIMIZATION_PAIR_IDENTITY_EXPOSURE_CONTRAST = <OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_EXPOSURE_CONTRAST: 128>¶

OPTIMIZATION_PAIR_IDENTITY_FIXED_FUNCTION = <OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_FIXED_FUNCTION: 256>¶

OPTIMIZATION_PAIR_IDENTITY_GAMMA = <OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_GAMMA: 512>¶

OPTIMIZATION_PAIR_IDENTITY_GRADING = <OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_GRADING: 8192>¶

OPTIMIZATION_PAIR_IDENTITY_LOG = <OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_LOG: 4096>¶

OPTIMIZATION_PAIR_IDENTITY_LUT1D = <OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_LUT1D: 1024>¶

OPTIMIZATION_PAIR_IDENTITY_LUT3D = <OptimizationFlags.OPTIMIZATION_PAIR_IDENTITY_LUT3D: 2048>¶

OPTIMIZATION_SIMPLIFY_OPS = <OptimizationFlags.OPTIMIZATION_SIMPLIFY_OPS: 134217728>¶

OPTIMIZATION_VERY_GOOD = <OptimizationFlags.OPTIMIZATION_VERY_GOOD: 263995331>¶

enum OpenColorIO_v2_2dev::OptimizationFlags¶

Provides control over how the ops in a Processor are combined in order to improve performance.

Values:

enumerator OPTIMIZATION_NONE¶: Do not optimize.

enumerator OPTIMIZATION_IDENTITY¶: Replace identity ops (other than gamma).

enumerator OPTIMIZATION_IDENTITY_GAMMA¶: Replace identity gamma ops.

enumerator OPTIMIZATION_PAIR_IDENTITY_CDL¶: Replace a pair of ops where one is the inverse of the other.

enumerator OPTIMIZATION_PAIR_IDENTITY_EXPOSURE_CONTRAST¶

enumerator OPTIMIZATION_PAIR_IDENTITY_FIXED_FUNCTION¶

enumerator OPTIMIZATION_PAIR_IDENTITY_GAMMA¶

enumerator OPTIMIZATION_PAIR_IDENTITY_LUT1D¶

enumerator OPTIMIZATION_PAIR_IDENTITY_LUT3D¶

enumerator OPTIMIZATION_PAIR_IDENTITY_LOG¶

enumerator OPTIMIZATION_PAIR_IDENTITY_GRADING¶

enumerator OPTIMIZATION_COMP_EXPONENT¶: Compose a pair of ops into a single op.

enumerator OPTIMIZATION_COMP_GAMMA¶

enumerator OPTIMIZATION_COMP_MATRIX¶

enumerator OPTIMIZATION_COMP_LUT1D¶

enumerator OPTIMIZATION_COMP_LUT3D¶

enumerator OPTIMIZATION_COMP_RANGE¶

enumerator OPTIMIZATION_COMP_SEPARABLE_PREFIX¶: For integer and half bit-depths only, replace separable ops (i.e. no channel crosstalk ops) by a single 1D LUT of input bit-depth domain.

enumerator OPTIMIZATION_LUT_INV_FAST¶: Implement inverse Lut1D and Lut3D evaluations using a a forward LUT (faster but less accurate). Note that GPU evals always do FAST.

enumerator OPTIMIZATION_FAST_LOG_EXP_POW¶

enumerator OPTIMIZATION_SIMPLIFY_OPS¶

enumerator OPTIMIZATION_NO_DYNAMIC_PROPERTIES¶: Turn off dynamic control of any ops that offer adjustment of parameter values after finalization (e.g. ExposureContrast).

enumerator OPTIMIZATION_ALL¶: Apply all possible optimizations.

enumerator OPTIMIZATION_LOSSLESS¶

enumerator OPTIMIZATION_VERY_GOOD¶

enumerator OPTIMIZATION_GOOD¶

enumerator OPTIMIZATION_DRAFT¶: For quite lossy optimizations.

enumerator OPTIMIZATION_DEFAULT¶

ProcessorCacheFlags¶

class PyOpenColorIO.ProcessorCacheFlags¶

cpp:type:: Enum to control the behavior of the internal caches e.g. the processor cache in

Members:

PROCESSOR_CACHE_OFF :

PROCESSOR_CACHE_ENABLED :

PROCESSOR_CACHE_SHARE_DYN_PROPERTIES :

PROCESSOR_CACHE_DEFAULT :

property name → str¶

PROCESSOR_CACHE_DEFAULT = <ProcessorCacheFlags.PROCESSOR_CACHE_DEFAULT: 3>¶

PROCESSOR_CACHE_ENABLED = <ProcessorCacheFlags.PROCESSOR_CACHE_ENABLED: 1>¶

PROCESSOR_CACHE_OFF = <ProcessorCacheFlags.PROCESSOR_CACHE_OFF: 0>¶

PROCESSOR_CACHE_SHARE_DYN_PROPERTIES = <ProcessorCacheFlags.PROCESSOR_CACHE_SHARE_DYN_PROPERTIES: 2>¶