Merge d1b88f3 into 4286761

dask_image/ndmeasure/__init__.py

@@ -30,6 +30,7 @@
     "minimum_position",
     "standard_deviation",
     "sum",
+    "sum_labels",
     "variance",
 ]
 
@@ -678,9 +679,9 @@ def standard_deviation(image, label_image=None, index=None):
     return std_lbl
 
 
-def sum(image, label_image=None, index=None):
+def sum_labels(image, label_image=None, index=None):
     """
-    Find the sum over an image at specified subregions.
+    Find the sum of all pixels over specified subregions of an image.
 
     Parameters
     ----------
@@ -696,7 +697,7 @@ def sum(image, label_image=None, index=None):
 
     Returns
     -------
-    sum : ndarray
+    sum_lbl : ndarray
         Sum of ``image`` over the ``index`` selected regions from
         ``label_image``.
     """
@@ -712,6 +713,12 @@ def sum(image, label_image=None, index=None):
     return sum_lbl
 
 
+def sum(image, label_image=None, index=None):
+    """DEPRECATED FUNCTION. Use `sum_labels` instead."""
+    warnings.warn("DEPRECATED FUNCTION. Use `sum_labels` instead.", DeprecationWarning)
+    return sum_labels(image, label_image=label_image, index=index)
+
+
 def variance(image, label_image=None, index=None):
     """
     Find the variance over an image at specified subregions.

docs/coverage.rst

@@ -212,7 +212,7 @@ This table shows which SciPy ndimage functions are supported by dask-image.
    * - ``standard_deviation``
      - ✓
      - ✓
-   * - ``sum``
+   * - ``sum_labels``
      - ✓
      - ✓
    * - ``uniform_filter``

tests/test_dask_image/test_ndmeasure/test_core.py

@@ -2,14 +2,16 @@
 # -*- coding: utf-8 -*-
 
 from __future__ import absolute_import
-
+from distutils.version import LooseVersion
+import scipy
 import itertools as it
 import warnings as wrn
 
 import pytest
 
 import numpy as np
 
+import scipy
 import scipy.ndimage as spnd
 
 import dask.array as da
@@ -28,7 +30,7 @@
         "minimum",
         "minimum_position",
         "standard_deviation",
-        "sum",
+        "sum_labels",
         "variance",
     ]
 )
@@ -88,7 +90,7 @@ def test_center_of_mass(datatype):
         "minimum",
         "minimum_position",
         "standard_deviation",
-        "sum",
+        "sum_labels",
         "variance",
     ]
 )
@@ -110,7 +112,13 @@ def test_center_of_mass(datatype):
     ]
 )
 def test_measure_props(funcname, shape, chunks, has_lbls, ind):
-    sp_func = getattr(spnd, funcname)
+    # early scipy version uses a different name sum insted of sum_labels.
+    if funcname == 'sum_labels' and scipy.__version__ < LooseVersion('1.5.0'):
+        scipy_funcname = 'sum'
+    else:
+        scipy_funcname = funcname
+
+    sp_func = getattr(spnd, scipy_funcname)
     da_func = getattr(dask_image.ndmeasure, funcname)
 
     a = np.random.random(shape)