1.. _python-transforms:
2
3Python Transforms
4=================
5
6Transform
7*********
8
9.. autoclass:: PyOpenColorIO.Transform
10    :members:
11    :undoc-members:
12
13AllocationTransform
14*******************
15
16.. code-block:: python
17
18    import PyOpenColorIO as OCIO
19    transform = OCIO.AllocationTransform()
20    transform.setAllocation(OCIO.Constants.ALLOCATION_LG2)
21
22.. autoclass:: PyOpenColorIO.AllocationTransform
23    :members:
24    :undoc-members:
25    :inherited-members:
26
27CDLTransform
28************
29
30.. code-block:: python
31
32    import PyOpenColorIO as OCIO
33
34    cdl = OCIO.CDLTransform()
35    # Set the slope, offset, power, and saturation for each channel.
36    cdl.setSOP([, , , , , , , , ])
37    cdl.setSat([, , ])
38    cdl.getSatLumaCoefs()
39
40.. autoclass:: PyOpenColorIO.CDLTransform
41    :members:
42    :undoc-members:
43    :inherited-members:
44
45ColorSpaceTransform
46*******************
47
48This class is meant so that ColorSpace conversions can be reused, referencing ColorSpaces that already exist.
49
50.. note::
51    Careless use of this may create infinite loops, so avoid referencing the colorspace you're in.
52
53.. code-block:: python
54
55    import PyOpenColorIO as OCIO
56    transform = OCIO.ColorSpaceTransform()
57
58.. autoclass:: PyOpenColorIO.ColorSpaceTransform
59    :members:
60    :undoc-members:
61    :inherited-members:
62
63DisplayTransform
64****************
65
66.. code-block:: python
67
68    import PyOpenColorIO as OCIO
69    transform = OCIO.DisplayTransform()
70
71.. autoclass:: PyOpenColorIO.DisplayTransform
72    :members:
73    :undoc-members:
74    :inherited-members:
75
76ExponentTransform
77*****************
78
79.. code-block:: python
80
81    import PyOpenColorIO as OCIO
82    transform = OCIO.ExponentTransform()
83
84.. autoclass:: PyOpenColorIO.ExponentTransform
85    :members:
86    :undoc-members:
87    :inherited-members:
88
89FileTransform
90*************
91
92.. autoclass:: PyOpenColorIO.FileTransform
93    :members:
94    :undoc-members:
95    :inherited-members:
96
97GroupTransform
98**************
99
100.. autoclass:: PyOpenColorIO.GroupTransform
101    :members:
102    :undoc-members:
103    :inherited-members:
104
105LogTransform
106************
107
108.. code-block:: python
109
110    import PyOpenColorIO as OCIO
111
112:py:class:`PyOpenColorIO.LogTransform` is used to define a log transform. The direction of
113the transform and its numerical base can be specified.
114
115.. autoclass:: PyOpenColorIO.LogTransform
116    :members:
117    :undoc-members:
118    :inherited-members:
119
120LookTransform
121*************
122
123.. autoclass:: PyOpenColorIO.LookTransform
124    :members:
125    :undoc-members:
126    :inherited-members:
127
128MatrixTransform
129***************
130
131.. autoclass:: PyOpenColorIO.MatrixTransform
132    :members:
133    :undoc-members:
134    :inherited-members:
135