Added documentation for individual functions

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

diff --git a/aces_1.0.0/python/aces_ocio/colorspaces/sony.py b/aces_1.0.0/python/aces_ocio/colorspaces/sony.py
index 9c7026a..981b687 100644 (file)
--- a/aces_1.0.0/python/aces_ocio/colorspaces/sony.py
+++ b/aces_1.0.0/python/aces_ocio/colorspaces/sony.py
@@ -28,24 +28,31 @@ __all__ = ['create_s_log',
 
 def create_s_log(gamut,
                  transfer_function,
-                 name,
                  lut_directory,
                  lut_resolution_1d,
                  aliases):
     """
-    Object description.
-
-    SLog to ACES.
+    Creates colorspace covering the conversion from Sony spaces 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)
@@ -66,7 +73,7 @@ def create_s_log(gamut,
             transfer_function.replace('-', ''),
             gamut.replace('-', '').replace(' ', '_'))
 
-    # 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]
@@ -221,13 +228,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 Sony cameras and encodings 
     """
 
     colorspaces = []
@@ -236,7 +245,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_log1_s_gamut = create_s_log(
         'S-Gamut',
         'S-Log1',
-        'S-Log',
         lut_directory,
         lut_resolution_1d,
         ['slog1_sgamut'])
@@ -246,7 +254,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_log2_s_gamut = create_s_log(
         'S-Gamut',
         'S-Log2',
-        'S-Log2',
         lut_directory,
         lut_resolution_1d,
         ['slog2_sgamut'])
@@ -255,7 +262,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_log2_s_gamut_daylight = create_s_log(
         'S-Gamut Daylight',
         'S-Log2',
-        'S-Log2',
         lut_directory,
         lut_resolution_1d,
         ['slog2_sgamutday'])
@@ -264,7 +270,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_log2_s_gamut_tungsten = create_s_log(
         'S-Gamut Tungsten',
         'S-Log2',
-        'S-Log2',
         lut_directory,
         lut_resolution_1d,
         ['slog2_sgamuttung'])
@@ -274,7 +279,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_log3_s_gamut3Cine = create_s_log(
         'S-Gamut3.Cine',
         'S-Log3',
-        'S-Log3',
         lut_directory,
         lut_resolution_1d,
         ['slog3_sgamutcine'])
@@ -283,7 +287,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_log3_s_gamut3 = create_s_log(
         'S-Gamut3',
         'S-Log3',
-        'S-Log3',
         lut_directory,
         lut_resolution_1d,
         ['slog3_sgamut3'])
@@ -293,7 +296,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_log1 = create_s_log(
         '',
         'S-Log1',
-        'S-Log',
         lut_directory,
         lut_resolution_1d,
         ['crv_slog1'])
@@ -302,7 +304,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_log2 = create_s_log(
         '',
         'S-Log2',
-        'S-Log2',
         lut_directory,
         lut_resolution_1d,
         ['crv_slog2'])
@@ -311,7 +312,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_log3 = create_s_log(
         '',
         'S-Log3',
-        'S-Log3',
         lut_directory,
         lut_resolution_1d,
         ['crv_slog3'])
@@ -321,7 +321,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_gamut = create_s_log(
         'S-Gamut',
         '',
-        'S-Log',
         lut_directory,
         lut_resolution_1d,
         ['lin_sgamut'])
@@ -330,7 +329,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_gamut_daylight = create_s_log(
         'S-Gamut Daylight',
         '',
-        'S-Log2',
         lut_directory,
         lut_resolution_1d,
         ['lin_sgamutday'])
@@ -339,7 +337,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_gamut_tungsten = create_s_log(
         'S-Gamut Tungsten',
         '',
-        'S-Log2',
         lut_directory,
         lut_resolution_1d,
         ['lin_sgamuttung'])
@@ -348,7 +345,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_gamut3Cine = create_s_log(
         'S-Gamut3.Cine',
         '',
-        'S-Log3',
         lut_directory,
         lut_resolution_1d,
         ['lin_sgamut3cine'])
@@ -357,7 +353,6 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     s_gamut3 = create_s_log(
         'S-Gamut3',
         '',
-        'S-Log3',
         lut_directory,
         lut_resolution_1d,
         ['lin_sgamut3'])