Add docstrings skeletons.

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

diff --git a/aces_1.0.0/python/aces_ocio/generateLUT.py b/aces_1.0.0/python/aces_ocio/generateLUT.py
index 74c1554..8e420aa 100644 (file)
--- a/aces_1.0.0/python/aces_ocio/generateLUT.py
+++ b/aces_1.0.0/python/aces_ocio/generateLUT.py
@@ -33,14 +33,44 @@ import OpenImageIO as oiio
 
 from aces_ocio.process import Process
 
+__author__ = 'ACES Developers'
+__copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
+__license__ = ''
+__maintainer__ = 'ACES Developers'
+__email__ = 'aces@oscars.org'
+__status__ = 'Production'
+
+__all__ = ['generate1dLUTImage',
+           'writeSPI1D',
+           'generate1dLUTFromImage',
+           'generate3dLUTImage',
+           'generate3dLUTFromImage',
+           'applyCTLToImage',
+           'convertBitDepth',
+           'generate1dLUTFromCTL',
+           'correctLUTImage',
+           'generate3dLUTFromCTL',
+           'main']
+
 
-#
-# Functions used to generate LUTs using CTL transforms
-#
 def generate1dLUTImage(ramp1dPath,
                        resolution=1024,
                        minValue=0.0,
                        maxValue=1.0):
+    """
+    Object description.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     # print("Generate 1d LUT image - %s" % ramp1dPath)
 
     # open image
@@ -69,9 +99,24 @@ def generate1dLUTImage(ramp1dPath,
     ramp.close()
 
 
-# Credit to Alex Fry for the original single channel version of the spi1d
-# writer
 def writeSPI1D(filename, fromMin, fromMax, data, entries, channels):
+    """
+    Object description.
+
+    Credit to *Alex Fry* for the original single channel version of the spi1d
+    writer.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     f = file(filename, 'w')
     f.write("Version 1\n")
     f.write("From %f %f\n" % (fromMin, fromMax))
@@ -91,6 +136,20 @@ def generate1dLUTFromImage(ramp1dPath,
                            outputPath=None,
                            minValue=0.0,
                            maxValue=1.0):
+    """
+    Object description.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     if outputPath == None:
         outputPath = ramp1dPath + ".spi1d"
 
@@ -114,6 +173,20 @@ def generate1dLUTFromImage(ramp1dPath,
 
 
 def generate3dLUTImage(ramp3dPath, resolution=32):
+    """
+    Object description.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     args = ["--generate",
             "--cubesize",
             str(resolution),
@@ -128,6 +201,20 @@ def generate3dLUTImage(ramp3dPath, resolution=32):
 
 
 def generate3dLUTFromImage(ramp3dPath, outputPath=None, resolution=32):
+    """
+    Object description.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     if outputPath == None:
         outputPath = ramp3dPath + ".spi3d"
 
@@ -153,6 +240,20 @@ def applyCTLToImage(inputImage,
                     outputScale=1.0,
                     globalParams={},
                     acesCTLReleaseDir=None):
+    """
+    Object description.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     if len(ctlPaths) > 0:
         ctlenv = os.environ
         if acesCTLReleaseDir != None:
@@ -185,6 +286,20 @@ def applyCTLToImage(inputImage,
 
 
 def convertBitDepth(inputImage, outputImage, depth):
+    """
+    Object description.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     args = [inputImage,
             "-d",
             depth,
@@ -207,6 +322,20 @@ def generate1dLUTFromCTL(lutPath,
                          acesCTLReleaseDir=None,
                          minValue=0.0,
                          maxValue=1.0):
+    """
+    Object description.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     # print(lutPath)
     # print(ctlPaths)
 
@@ -245,6 +374,20 @@ def generate1dLUTFromCTL(lutPath,
 
 
 def correctLUTImage(transformedLUTImage, correctedLUTImage, lutResolution):
+    """
+    Object description.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     # open image
     transformed = oiio.ImageInput.open(transformedLUTImage)
 
@@ -319,6 +462,20 @@ def generate3dLUTFromCTL(lutPath,
                          globalParams={},
                          cleanup=True,
                          acesCTLReleaseDir=None):
+    """
+    Object description.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     # print(lutPath)
     # print(ctlPaths)
 
@@ -362,6 +519,20 @@ def generate3dLUTFromCTL(lutPath,
 
 
 def main():
+    """
+    Object description.
+
+    Parameters
+    ----------
+    parameter : type
+        Parameter description.
+
+    Returns
+    -------
+    type
+         Return value description.
+    """
+
     import optparse
 
     p = optparse.OptionParser(