Update "__all__" attributes.
[OpenColorIO-Configs.git] / aces_1.0.0 / python / aces_ocio / colorspaces / general.py
index 1a05f06..cb935f7 100644 (file)
@@ -16,7 +16,6 @@ import aces_ocio.generate_lut as genlut
 from aces_ocio.colorspaces import aces
 from aces_ocio.utilities import ColorSpace, mat44_from_mat33
 
-
 __author__ = 'ACES Developers'
 __copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
 __license__ = ''
@@ -25,7 +24,16 @@ __email__ = 'aces@oscars.org'
 __status__ = 'Production'
 
 __all__ = ['create_matrix_colorspace',
-           'create_colorspaces']
+           'create_transfer_colorspace',
+           'create_matrix_plus_transfer_colorspace',
+           'transfer_function_sRGB_to_linear',
+           'transfer_function_Rec709_to_linear',
+           'transfer_function_Rec2020_10bit_to_linear',
+           'transfer_function_Rec2020_12bit_to_linear',
+           'transfer_function_Rec1886_to_linear',
+           'create_colorspaces',
+           'create_raw']
+
 
 # -------------------------------------------------------------------------
 # *Matrix Transform*
@@ -33,7 +41,7 @@ __all__ = ['create_matrix_colorspace',
 def create_matrix_colorspace(name='matrix',
                              from_reference_values=None,
                              to_reference_values=None,
-                             aliases=[]):
+                             aliases=None):
     """
     Object description.
 
@@ -54,6 +62,9 @@ def create_matrix_colorspace(name='matrix',
     if to_reference_values is None:
         to_reference_values = []
 
+    if aliases is None:
+        aliases = []
+
     cs = ColorSpace(name)
     cs.description = 'The %s color space' % name
     cs.aliases = aliases
@@ -61,7 +72,7 @@ def create_matrix_colorspace(name='matrix',
     cs.family = 'Utility'
     cs.is_data = False
 
-    # A linear space needs allocation variables
+    # A linear space needs allocation variables.
     cs.allocation_type = ocio.Constants.ALLOCATION_UNIFORM
     cs.allocation_vars = [0, 1]
 
@@ -83,6 +94,7 @@ def create_matrix_colorspace(name='matrix',
 
     return cs
 
+
 # -------------------------------------------------------------------------
 # *Transfer Function Transform*
 # -------------------------------------------------------------------------
@@ -91,7 +103,7 @@ def create_transfer_colorspace(name='transfer',
                                transfer_function=lambda x: x,
                                lut_directory='/tmp',
                                lut_resolution_1d=1024,
-                               aliases=[]):
+                               aliases=None):
     """
     Object description.
 
@@ -106,6 +118,9 @@ def create_transfer_colorspace(name='transfer',
          Return value description.
     """
 
+    if aliases is None:
+        aliases = []
+
     cs = ColorSpace(name)
     cs.description = 'The %s color space' % name
     cs.aliases = aliases
@@ -113,16 +128,16 @@ def create_transfer_colorspace(name='transfer',
     cs.family = 'Utility'
     cs.is_data = False
 
-    # A linear space needs allocation variables
+    # A linear space needs allocation variables.
     cs.allocation_type = ocio.Constants.ALLOCATION_UNIFORM
     cs.allocation_vars = [0, 1]
 
-    # Sample the transfer function
+    # Sampling the transfer function.
     data = array.array('f', '\0' * lut_resolution_1d * 4)
     for c in range(lut_resolution_1d):
         data[c] = transfer_function(c / (lut_resolution_1d - 1))
 
-    # Write the sampled data to a LUT
+    # Writing the sampled data to a *LUT*.
     lut = '%s_to_linear.spi1d' % transfer_function_name
     genlut.write_SPI_1d(
         os.path.join(lut_directory, lut),
@@ -132,7 +147,7 @@ def create_transfer_colorspace(name='transfer',
         lut_resolution_1d,
         1)
 
-    # Create the 'to_reference' transforms
+    # Creating the *to_reference* transforms.
     cs.to_reference_transforms = []
     cs.to_reference_transforms.append({
         'type': 'lutFile',
@@ -140,23 +155,24 @@ def create_transfer_colorspace(name='transfer',
         'interpolation': 'linear',
         'direction': 'forward'})
 
-    # Create the 'from_reference' transforms
+    # Creating the *from_reference* transforms.
     cs.from_reference_transforms = []
 
     return cs
-# create_transfer_colorspace
+
 
 # -------------------------------------------------------------------------
 # *Transfer Function + Matrix Transform*
 # -------------------------------------------------------------------------
-def create_matrix_plus_transfer_colorspace(name='matrix_plus_transfer',
-                                           transfer_function_name='transfer_function',
-                                           transfer_function=lambda x: x,
-                                           lut_directory='/tmp',
-                                           lut_resolution_1d=1024,
-                                           from_reference_values=None,
-                                           to_reference_values=None,
-                                           aliases=[]):
+def create_matrix_plus_transfer_colorspace(
+        name='matrix_plus_transfer',
+        transfer_function_name='transfer_function',
+        transfer_function=lambda x: x,
+        lut_directory='/tmp',
+        lut_resolution_1d=1024,
+        from_reference_values=None,
+        to_reference_values=None,
+        aliases=None):
     """
     Object description.
 
@@ -177,6 +193,9 @@ def create_matrix_plus_transfer_colorspace(name='matrix_plus_transfer',
     if to_reference_values is None:
         to_reference_values = []
 
+    if aliases is None:
+        aliases = []
+
     cs = ColorSpace(name)
     cs.description = 'The %s color space' % name
     cs.aliases = aliases
@@ -184,16 +203,16 @@ def create_matrix_plus_transfer_colorspace(name='matrix_plus_transfer',
     cs.family = 'Utility'
     cs.is_data = False
 
-    # A linear space needs allocation variables
+    # A linear space needs allocation variables.
     cs.allocation_type = ocio.Constants.ALLOCATION_UNIFORM
     cs.allocation_vars = [0, 1]
 
-    # Sample the transfer function
+    # Sampling the transfer function.
     data = array.array('f', '\0' * lut_resolution_1d * 4)
     for c in range(lut_resolution_1d):
         data[c] = transfer_function(c / (lut_resolution_1d - 1))
 
-    # Write the sampled data to a LUT
+    # Writing the sampled data to a *LUT*.
     lut = '%s_to_linear.spi1d' % transfer_function_name
     genlut.write_SPI_1d(
         os.path.join(lut_directory, lut),
@@ -203,7 +222,7 @@ def create_matrix_plus_transfer_colorspace(name='matrix_plus_transfer',
         lut_resolution_1d,
         1)
 
-    # Create the 'to_reference' transforms
+    # Creating the *to_reference* transforms.
     cs.to_reference_transforms = []
     if to_reference_values:
         cs.to_reference_transforms.append({
@@ -218,7 +237,7 @@ def create_matrix_plus_transfer_colorspace(name='matrix_plus_transfer',
                 'matrix': mat44_from_mat33(matrix),
                 'direction': 'forward'})
 
-    # Create the 'from_reference' transforms
+    # Creating the *from_reference* transforms.
     cs.from_reference_transforms = []
     if from_reference_values:
         for matrix in from_reference_values:
@@ -234,9 +253,9 @@ def create_matrix_plus_transfer_colorspace(name='matrix_plus_transfer',
             'direction': 'inverse'})
 
     return cs
-# create_matrix_plus_transfer_colorspace
 
-# Transfer functions for standard color spaces
+
+# Transfer functions for standard colorspaces.
 def transfer_function_sRGB_to_linear(v):
     a = 1.055
     b = 0.04045
@@ -244,59 +263,63 @@ def transfer_function_sRGB_to_linear(v):
     g = 2.4
 
     if v < b:
-        return v/d
+        return v / d
     return pow(((v + (a - 1)) / a), g)
 
+
 def transfer_function_Rec709_to_linear(v):
     a = 1.099
     b = 0.018
     d = 4.5
-    g = (1.0/0.45)
+    g = (1.0 / 0.45)
 
-    if v < b*d:
-        return v/d
+    if v < b * d:
+        return v / d
 
     return pow(((v + (a - 1)) / a), g)
 
+
 def transfer_function_Rec2020_10bit_to_linear(v):
     a = 1.099
     b = 0.018
     d = 4.5
-    g = (1.0/0.45)
+    g = (1.0 / 0.45)
 
-    if v < b*d:
-        return v/d
+    if v < b * d:
+        return v / d
 
     return pow(((v + (a - 1)) / a), g)
 
+
 def transfer_function_Rec2020_12bit_to_linear(v):
     a = 1.0993
     b = 0.0181
     d = 4.5
-    g = (1.0/0.45)
+    g = (1.0 / 0.45)
 
-    if v < b*d:
-        return v/d
+    if v < b * d:
+        return v / d
 
     return pow(((v + (a - 1)) / a), g)
 
+
 def transfer_function_Rec1886_to_linear(v):
     g = 2.4
     Lw = 1
     Lb = 0
 
-    # Ignoring legal to full scaling for now
-    #v = (1023.0*v - 64.0)/876.0
+    # Ignoring legal to full scaling for now.
+    # v = (1023.0*v - 64.0)/876.0
 
-    t = pow(Lw, 1.0/g) - pow(Lb, 1.0/g)
+    t = pow(Lw, 1.0 / g) - pow(Lb, 1.0 / g)
     a = pow(t, g)
-    b = pow(Lb, 1.0/g)/t
+    b = pow(Lb, 1.0 / g) / t
+
+    return a * pow(max((v + b), 0.0), g)
 
-    return a*pow(max((v + b), 0.0), g)
 
 def create_colorspaces(lut_directory,
-                       lut_resolution_1d,
-                       lut_resolution_3d):
+                       lut_resolution_1d):
     """
     Generates the colorspace conversions.
 
@@ -313,19 +336,19 @@ def create_colorspaces(lut_directory,
 
     colorspaces = []
 
-    #
+    # -------------------------------------------------------------------------
     # XYZ
-    #
+    # -------------------------------------------------------------------------
     cs = create_matrix_colorspace('XYZ-D60',
-                               to_reference_values=[aces.ACES_XYZ_TO_AP0],
-                               from_reference_values=[aces.ACES_AP0_TO_XYZ],
-                               aliases=["lin_xyz_d60"])
+                                  to_reference_values=[aces.ACES_XYZ_TO_AP0],
+                                  from_reference_values=[aces.ACES_AP0_TO_XYZ],
+                                  aliases=['lin_xyz_d60'])
     colorspaces.append(cs)
 
-    #
+    # -------------------------------------------------------------------------
     # P3-D60
-    #
-    # *ACES* to *Linear*, *P3D60* primaries.
+    # -------------------------------------------------------------------------
+    # *ACES* to *Linear*, *P3D60* primaries
     XYZ_to_P3D60 = [2.4027414142, -0.8974841639, -0.3880533700,
                     -0.8325796487, 1.7692317536, 0.0237127115,
                     0.0388233815, -0.0824996856, 1.0363685997]
@@ -333,13 +356,13 @@ def create_colorspaces(lut_directory,
     cs = create_matrix_colorspace(
         'Linear - P3-D60',
         from_reference_values=[aces.ACES_AP0_TO_XYZ, XYZ_to_P3D60],
-        aliases=["lin_p3d60"])
+        aliases=['lin_p3d60'])
     colorspaces.append(cs)
 
-    #
+    # -------------------------------------------------------------------------
     # P3-DCI
-    #
-    # *ACES* to *Linear*, *P3DCI* primaries.
+    # -------------------------------------------------------------------------
+    # *ACES* to *Linear*, *P3DCI* primaries
     XYZ_to_P3DCI = [2.7253940305, -1.0180030062, -0.4401631952,
                     -0.7951680258, 1.6897320548, 0.0226471906,
                     0.0412418914, -0.0876390192, 1.1009293786]
@@ -347,14 +370,14 @@ def create_colorspaces(lut_directory,
     cs = create_matrix_colorspace(
         'Linear - P3-DCI',
         from_reference_values=[aces.ACES_AP0_TO_XYZ, XYZ_to_P3DCI],
-        aliases=["lin_p3dci"])
+        aliases=['lin_p3dci'])
     colorspaces.append(cs)
 
-    #
+    # -------------------------------------------------------------------------
     # sRGB
-    #
+    # -------------------------------------------------------------------------
     # *ACES* to *Linear*, *Rec. 709* primaries.
-    # sRGB and Rec 709 use the same gamut
+    # *sRGB* and *Rec 709* use the same gamut.
     XYZ_to_Rec709 = [3.2409699419, -1.5373831776, -0.4986107603,
                      -0.9692436363, 1.8759675015, 0.0415550574,
                      0.0556300797, -0.2039769589, 1.0569715142]
@@ -362,7 +385,7 @@ def create_colorspaces(lut_directory,
     cs = create_matrix_colorspace(
         'Linear - sRGB',
         from_reference_values=[aces.ACES_AP0_TO_XYZ, XYZ_to_Rec709],
-        aliases=["lin_srgb"])
+        aliases=['lin_srgb'])
     colorspaces.append(cs)
 
     # *Linear* to *sRGB* Transfer Function*
@@ -372,7 +395,7 @@ def create_colorspaces(lut_directory,
         transfer_function_sRGB_to_linear,
         lut_directory,
         lut_resolution_1d,
-        aliases=["crv_srgb"])
+        aliases=['crv_srgb'])
     colorspaces.append(cs)
 
     # *ACES* to *sRGB* Primaries + Transfer Function*
@@ -383,13 +406,13 @@ def create_colorspaces(lut_directory,
         lut_directory,
         lut_resolution_1d,
         from_reference_values=[aces.ACES_AP0_TO_XYZ, XYZ_to_Rec709],
-        aliases=["srgb"])
+        aliases=['srgb'])
     colorspaces.append(cs)
 
-    #
+    # -------------------------------------------------------------------------
     # Rec 709
-    #
-    # *ACES* to *Linear*, *Rec. 709* primaries.
+    # -------------------------------------------------------------------------
+    # *ACES* to *Linear*, *Rec. 709* primaries
     XYZ_to_Rec709 = [3.2409699419, -1.5373831776, -0.4986107603,
                      -0.9692436363, 1.8759675015, 0.0415550574,
                      0.0556300797, -0.2039769589, 1.0569715142]
@@ -397,7 +420,7 @@ def create_colorspaces(lut_directory,
     cs = create_matrix_colorspace(
         'Linear - Rec.709',
         from_reference_values=[aces.ACES_AP0_TO_XYZ, XYZ_to_Rec709],
-        aliases=["lin_rec709"])
+        aliases=['lin_rec709'])
     colorspaces.append(cs)
 
     # *Linear* to *Rec. 709* Transfer Function*
@@ -407,7 +430,7 @@ def create_colorspaces(lut_directory,
         transfer_function_Rec709_to_linear,
         lut_directory,
         lut_resolution_1d,
-        aliases=["crv_rec709"])
+        aliases=['crv_rec709'])
     colorspaces.append(cs)
 
     # *ACES* to *Rec. 709* Primaries + Transfer Function*
@@ -418,13 +441,13 @@ def create_colorspaces(lut_directory,
         lut_directory,
         lut_resolution_1d,
         from_reference_values=[aces.ACES_AP0_TO_XYZ, XYZ_to_Rec709],
-        aliases=["rec709_camera"])
+        aliases=['rec709_camera'])
     colorspaces.append(cs)
 
-    #
+    # -------------------------------------------------------------------------
     # Rec 2020
-    #
-    # *ACES* to *Linear*, *Rec. 2020* primaries.
+    # -------------------------------------------------------------------------
+    # *ACES* to *Linear*, *Rec. 2020* primaries
     XYZ_to_Rec2020 = [1.7166511880, -0.3556707838, -0.2533662814,
                       -0.6666843518, 1.6164812366, 0.0157685458,
                       0.0176398574, -0.0427706133, 0.9421031212]
@@ -432,7 +455,7 @@ def create_colorspaces(lut_directory,
     cs = create_matrix_colorspace(
         'Linear - Rec.2020',
         from_reference_values=[aces.ACES_AP0_TO_XYZ, XYZ_to_Rec2020],
-        aliases=["lin_rec2020"])
+        aliases=['lin_rec2020'])
     colorspaces.append(cs)
 
     # *Linear* to *Rec. 2020 10 bit* Transfer Function*
@@ -442,7 +465,7 @@ def create_colorspaces(lut_directory,
         transfer_function_Rec2020_10bit_to_linear,
         lut_directory,
         lut_resolution_1d,
-        aliases=["crv_rec2020"])
+        aliases=['crv_rec2020'])
     colorspaces.append(cs)
 
     # *ACES* to *Rec. 2020 10 bit* Primaries + Transfer Function*
@@ -453,13 +476,12 @@ def create_colorspaces(lut_directory,
         lut_directory,
         lut_resolution_1d,
         from_reference_values=[aces.ACES_AP0_TO_XYZ, XYZ_to_Rec2020],
-        aliases=["rec2020_camera"])
+        aliases=['rec2020_camera'])
     colorspaces.append(cs)
 
-    #
+    # -------------------------------------------------------------------------
     # Rec 1886
-    #
-
+    # -------------------------------------------------------------------------
     # *Linear* to *Rec.1886* Transfer Function*
     cs = create_transfer_colorspace(
         'Curve - Rec.1886',
@@ -467,7 +489,7 @@ def create_colorspaces(lut_directory,
         transfer_function_Rec1886_to_linear,
         lut_directory,
         lut_resolution_1d,
-        aliases=["crv_rec1886"])
+        aliases=['crv_rec1886'])
     colorspaces.append(cs)
 
     # *ACES* to *sRGB* Primaries + Transfer Function*
@@ -478,7 +500,7 @@ def create_colorspaces(lut_directory,
         lut_directory,
         lut_resolution_1d,
         from_reference_values=[aces.ACES_AP0_TO_XYZ, XYZ_to_Rec709],
-        aliases=["rec709_display"])
+        aliases=['rec709_display'])
     colorspaces.append(cs)
 
     # *ACES* to *sRGB* Primaries + Transfer Function*
@@ -489,13 +511,13 @@ def create_colorspaces(lut_directory,
         lut_directory,
         lut_resolution_1d,
         from_reference_values=[aces.ACES_AP0_TO_XYZ, XYZ_to_Rec2020],
-        aliases=["rec2020_display"])
+        aliases=['rec2020_display'])
     colorspaces.append(cs)
 
-    #
+    # -------------------------------------------------------------------------
     # ProPhoto
-    #
-    # *ACES* to *Linear*, *Pro Photo* primaries.
+    # -------------------------------------------------------------------------
+    # *ACES* to *Linear*, *Pro Photo* primaries
     AP0_to_RIMM = [1.2412367771, -0.1685692287, -0.0726675484,
                    0.0061203066, 1.083151174, -0.0892714806,
                    -0.0032853314, 0.0099796402, 0.9933056912]
@@ -503,13 +525,13 @@ def create_colorspaces(lut_directory,
     cs = create_matrix_colorspace(
         'Linear - RIMM ROMM (ProPhoto)',
         from_reference_values=[AP0_to_RIMM],
-        aliases=["lin_prophoto", "lin_rimm"])
+        aliases=['lin_prophoto', 'lin_rimm'])
     colorspaces.append(cs)
 
-    #
+    # -------------------------------------------------------------------------
     # Adobe RGB
-    #
-    # *ACES* to *Linear*, *Adobe RGB* primaries.
+    # -------------------------------------------------------------------------
+    # *ACES* to *Linear*, *Adobe RGB* primaries
     AP0_to_ADOBERGB = [1.7245603168, -0.4199935942, -0.3045667227,
                        -0.2764799142, 1.3727190877, -0.0962391734,
                        -0.0261255258, -0.0901747807, 1.1163003065]
@@ -517,14 +539,13 @@ def create_colorspaces(lut_directory,
     cs = create_matrix_colorspace(
         'Linear - Adobe RGB',
         from_reference_values=[AP0_to_ADOBERGB],
-        aliases=["lin_adobergb"])
+        aliases=['lin_adobergb'])
     colorspaces.append(cs)
 
-    #
+    # -------------------------------------------------------------------------
     # Adobe Wide Gamut RGB
-    #
-
-    # *ACES* to *Linear*, *Adobe Wide Gamut RGB* primaries.
+    # -------------------------------------------------------------------------
+    # *ACES* to *Linear*, *Adobe Wide Gamut RGB* primaries
     AP0_to_ADOBERGB = [1.3809814778, -0.1158594573, -0.2651220205,
                        0.0057015535, 1.0402949043, -0.0459964578,
                        -0.0038908746, -0.0597091815, 1.0636000561]
@@ -532,7 +553,7 @@ def create_colorspaces(lut_directory,
     cs = create_matrix_colorspace(
         'Linear - Adobe Wide Gamut RGB',
         from_reference_values=[AP0_to_ADOBERGB],
-        aliases=["lin_adobewidegamutrgb"])
+        aliases=['lin_adobewidegamutrgb'])
     colorspaces.append(cs)
 
     return colorspaces
@@ -540,14 +561,12 @@ def create_colorspaces(lut_directory,
 
 def create_raw():
     # *Raw* utility space
-    name = "Raw"
+    name = 'Raw'
     raw = ColorSpace(name)
     raw.description = 'The %s color space' % name
-    raw.aliases = ["raw"]
+    raw.aliases = ['raw']
     raw.equality_group = name
     raw.family = 'Utility'
     raw.is_data = True
 
     return raw
-
-