Added documentation for individual functions

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

diff --git a/aces_1.0.0/python/aces_ocio/colorspaces/red.py b/aces_1.0.0/python/aces_ocio/colorspaces/red.py
index 0a8f868..eefe9ef 100644 (file)
--- a/aces_1.0.0/python/aces_ocio/colorspaces/red.py
+++ b/aces_1.0.0/python/aces_ocio/colorspaces/red.py
@@ -12,7 +12,7 @@ import os
 
 import PyOpenColorIO as ocio
 
-import aces_ocio.lut as genlut
+import aces_ocio.generate_lut as genlut
 from aces_ocio.utilities import ColorSpace, mat44_from_mat33
 
 __author__ = 'ACES Developers'
@@ -32,19 +32,27 @@ def create_red_log_film(gamut,
                         lut_resolution_1d,
                         aliases=None):
     """
-    Object description.
-
-    RED colorspaces to ACES.
+    Creates colorspace covering the conversion from RED 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.
     """
 
     if aliases is None:
@@ -156,13 +164,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 RED cameras and encodings 
     """
 
     colorspaces = []
@@ -226,52 +236,52 @@ def create_colorspaces(lut_directory, lut_resolution_1d):
     colorspaces.append(red_log_film)
 
     # Primaries only
-    RED_dragon = create_red_log_film(
+    red_dragon = create_red_log_film(
         'DRAGONcolor',
         '',
         lut_directory,
         lut_resolution_1d,
         ['lin_dgn'])
-    colorspaces.append(RED_dragon)
+    colorspaces.append(red_dragon)
 
-    RED_dragon2 = create_red_log_film(
+    red_dragon2 = create_red_log_film(
         'DRAGONcolor2',
         '',
         lut_directory,
         lut_resolution_1d,
         ['lin_dgn2'])
-    colorspaces.append(RED_dragon2)
+    colorspaces.append(red_dragon2)
 
-    RED_color = create_red_log_film(
+    red_color = create_red_log_film(
         'REDcolor',
         '',
         lut_directory,
         lut_resolution_1d,
         ['lin_rc'])
-    colorspaces.append(RED_color)
+    colorspaces.append(red_color)
 
-    RED_color2 = create_red_log_film(
+    red_color2 = create_red_log_film(
         'REDcolor2',
         '',
         lut_directory,
         lut_resolution_1d,
         ['lin_rc2'])
-    colorspaces.append(RED_color2)
+    colorspaces.append(red_color2)
 
-    RED_color3 = create_red_log_film(
+    red_color3 = create_red_log_film(
         'REDcolor3',
         '',
         lut_directory,
         lut_resolution_1d,
         ['lin_rc3'])
-    colorspaces.append(RED_color3)
+    colorspaces.append(red_color3)
 
-    RED_color4 = create_red_log_film(
+    red_color4 = create_red_log_film(
         'REDcolor4',
         '',
         lut_directory,
         lut_resolution_1d,
         ['lin_rc4'])
-    colorspaces.append(RED_color4)
+    colorspaces.append(red_color4)
 
     return colorspaces