A comment missed the last commit

[OpenColorIO-Configs.git] / aces_1.0.0 / python / aces_ocio / colorspaces / arri.py

diff --git a/aces_1.0.0/python/aces_ocio/colorspaces/arri.py b/aces_1.0.0/python/aces_ocio/colorspaces/arri.py
index a1dab18..6b57b4a 100644 (file)
--- a/aces_1.0.0/python/aces_ocio/colorspaces/arri.py
+++ b/aces_1.0.0/python/aces_ocio/colorspaces/arri.py
@@ -34,19 +34,29 @@ def create_log_c(gamut,
                  lut_resolution_1d,
                  aliases):
     """
-    Object description.
-
-    LogC to ACES.
+    Creates colorspace covering the conversion from LogC to ACES, with various transfer 
+    functions and encoding gamuts covered
 
     Parameters
     ----------
-    parameter : type
-        Parameter description.
+    gamut : str
+        The name of the encoding gamut to use.
+    transfer_function : str
+        The name of the transfer function to use
+    exposure_index : str
+        The exposure index to use
+    lut_directory : str or unicode 
+        The directory to use when generating LUTs
+    lut_resolution_1d : int
+        The resolution of generated 1D LUTs
+    aliases : list of str
+        Aliases for this colorspace
 
     Returns
     -------
-    type
-         Return value description.
+    ColorSpace
+         A ColorSpace container class referencing the LUTs, matrices and identifying
+         information for the requested colorspace.
     """
 
     name = '%s (EI%s) - %s' % (transfer_function, exposure_index, gamut)
@@ -66,12 +76,11 @@ def create_log_c(gamut,
         cs.aces_transform_id = (
             'IDT.ARRI.Alexa-v3-logC-EI%s.a1.v1' % exposure_index)
 
-    # A linear space needs allocation variables
+    # A linear space needs allocation variables.
     if transfer_function == '':
         cs.allocation_type = ocio.Constants.ALLOCATION_LG2
         cs.allocation_vars = [-8, 5, 0.00390625]
 
-    # Globals.
     IDT_maker_version = '0.08'
 
     nominal_EI = 400
@@ -153,8 +162,7 @@ def create_log_c(gamut,
             'type': 'lutFile',
             'path': lut,
             'interpolation': 'linear',
-            'direction': 'forward'
-        })
+            'direction': 'forward'})
 
     if gamut == 'Wide Gamut':
         cs.to_reference_transforms.append({
@@ -162,8 +170,7 @@ def create_log_c(gamut,
             'matrix': mat44_from_mat33([0.680206, 0.236137, 0.083658,
                                         0.085415, 1.017471, -0.102886,
                                         0.002057, -0.062563, 1.060506]),
-            'direction': 'forward'
-        })
+            'direction': 'forward'})
 
     cs.from_reference_transforms = []
     return cs
@@ -175,13 +182,15 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
 
     Parameters
     ----------
-    parameter : type
-        Parameter description.
+    lut_directory : str or unicode 
+        The directory to use when generating LUTs
+    lut_resolution_1d : int
+        The resolution of generated 1D LUTs
 
     Returns
     -------
-    type
-         Return value description.
+    list
+         A list of colorspaces for ARRI cameras and encodings 
     """
 
     colorspaces = []