Added features documentation and image functions now return floats.

assamite · Aug 2, 2017 · 7acf8fe · 7acf8fe
1 parent 215ff3a
commit 7acf8fe
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/creamas/image.py b/creamas/image.py
@@ -64,7 +64,7 @@ def channel_portion(image, channel):
     relative_values = ch - np.sum(rgb, axis=0) / 2
     relative_values = np.maximum(np.zeros(ch.shape), relative_values)
 
-    return np.average(relative_values) / 255
+    return float(np.average(relative_values) / 255)
 
 
 def intensity(image):
@@ -80,4 +80,4 @@ def intensity(image):
         image = cv2.cvtColor(image, cv2.COLOR_RGB2GRAY) / 255
     elif issubclass(image.dtype.type, np.integer):
         image /= 255
-    return np.sum(image) / np.prod(image.shape)
+    return float(np.sum(image) / np.prod(image.shape))
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -13,5 +13,6 @@ API Documentation
     util
     rules
     mappers
+    features
     math
-    logging
+    logging
diff --git a/docs/source/features.rst b/docs/source/features.rst
@@ -0,0 +1,6 @@
+Features
+=======
+
+.. automodule:: creamas.features
+	:members:
+	:inherited-members:
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,5 +13,6 @@ API Documentation @@
         util
         rules
         mappers
+        features
         math
-        logging
+        logging