Added documentation for individual functions

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

diff --git a/aces_1.0.0/python/aces_ocio/colorspaces/canon.py b/aces_1.0.0/python/aces_ocio/colorspaces/canon.py
index e19f714..bbb5c8a 100644 (file)
--- a/aces_1.0.0/python/aces_ocio/colorspaces/canon.py
+++ b/aces_1.0.0/python/aces_ocio/colorspaces/canon.py
@@ -28,24 +28,31 @@ __all__ = ['create_c_log',
 
 def create_c_log(gamut,
                  transfer_function,
-                 name,
                  lut_directory,
                  lut_resolution_1d,
                  aliases):
     """
-    Object description.
-
-    Canon-Log to ACES.
+    Creates colorspace covering the conversion from CLog 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
+    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 - %s' % (transfer_function, gamut)
@@ -61,7 +68,7 @@ def create_c_log(gamut,
     cs.family = 'Input/Canon'
     cs.is_data = False
 
-    # 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]
@@ -162,13 +169,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 Canon cameras and encodings 
     """
 
     colorspaces = []
@@ -177,7 +186,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_1 = create_c_log(
         'Rec. 709 Daylight',
         'Canon-Log',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['canonlog_rec709day'])
@@ -186,7 +194,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_2 = create_c_log(
         'Rec. 709 Tungsten',
         'Canon-Log',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['canonlog_rec709tung'])
@@ -195,7 +202,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_3 = create_c_log(
         'DCI-P3 Daylight',
         'Canon-Log',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['canonlog_dcip3day'])
@@ -204,7 +210,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_4 = create_c_log(
         'DCI-P3 Tungsten',
         'Canon-Log',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['canonlog_dcip3tung'])
@@ -213,7 +218,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_5 = create_c_log(
         'Cinema Gamut Daylight',
         'Canon-Log',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['canonlog_cgamutday'])
@@ -222,7 +226,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_6 = create_c_log(
         'Cinema Gamut Tungsten',
         'Canon-Log',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['canonlog_cgamuttung'])
@@ -232,7 +235,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_7 = create_c_log(
         '',
         'Canon-Log',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['crv_canonlog'])
@@ -242,7 +244,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_8 = create_c_log(
         'Rec. 709 Daylight',
         '',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['lin_canonrec709day'])
@@ -251,7 +252,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_9 = create_c_log(
         'Rec. 709 Tungsten',
         '',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['lin_canonrec709tung'])
@@ -260,7 +260,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_10 = create_c_log(
         'DCI-P3 Daylight',
         '',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['lin_canondcip3day'])
@@ -269,7 +268,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_11 = create_c_log(
         'DCI-P3 Tungsten',
         '',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['lin_canondcip3tung'])
@@ -278,7 +276,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_12 = create_c_log(
         'Cinema Gamut Daylight',
         '',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['lin_canoncgamutday'])
@@ -287,7 +284,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     c_log_13 = create_c_log(
         'Cinema Gamut Tungsten',
         '',
-        'Canon-Log',
         lut_directory,
         lut_resolution_1d,
         ['lin_canoncgamuttung'])