Add DensityFiltration (#473)

* Add DensityFiltration * Remove effective_metric_params in radial * Replace warnings in image subpackage by ValueErrors for input dim > 4 * Remove unnecessary _is_fitted from ImageToPointCloud * Improve See alsos in images/filtrations.py * Add tests for bad input shapes in image subpackage Signed-off-by: Guillaume Tauzin <[email protected]> Co-authored-by: Umberto Lupo <[email protected]>
giotto-ai · Oct 4, 2020 · d089002 · d089002
1 parent 565a2ba
commit d089002
Show file tree

Hide file tree

Showing 7 changed files with 429 additions and 95 deletions.
diff --git a/doc/modules/images.rst b/doc/modules/images.rst
@@ -31,3 +31,4 @@ Filtrations
    images.DilationFiltration
    images.ErosionFiltration
    images.SignedDistanceFiltration
+   images.DensityFiltration
diff --git a/gtda/homology/cubical.py b/gtda/homology/cubical.py
@@ -44,7 +44,7 @@ class CubicalPersistence(BaseEstimator, TransformerMixin, PlotterMixin):
 
     periodic_dimensions : boolean ndarray of shape (n_dimensions,) or None, \
         optional, default: ``None``
-        Periodicity of the boundaries along each of the axis, where
+        Periodicity of the boundaries along each of the axes, where
         ``n_dimensions`` is the dimension of the images of the collection. The
         boolean in the `d`th position expresses whether the boundaries along
         the `d`th axis are periodic. The default ``None`` is equivalent to
@@ -69,7 +69,7 @@ class CubicalPersistence(BaseEstimator, TransformerMixin, PlotterMixin):
     Attributes
     ----------
     periodic_dimensions_ : boolean ndarray of shape (n_dimensions,)
-       Effective periodicity of the boundaries along each of the axis. Set in
+       Effective periodicity of the boundaries along each of the axes. Set in
        :meth:`fit`.
 
     infinity_values_ : float

diff --git a/gtda/images/__init__.py b/gtda/images/__init__.py
@@ -5,7 +5,8 @@
 
 from .preprocessing import Binarizer, Inverter, Padder, ImageToPointCloud
 from .filtrations import HeightFiltration, RadialFiltration, \
-    DilationFiltration, ErosionFiltration, SignedDistanceFiltration
+    DilationFiltration, ErosionFiltration, SignedDistanceFiltration, \
+    DensityFiltration
 
 __all__ = [
     'Binarizer',
@@ -17,4 +18,5 @@
     'DilationFiltration',
     'ErosionFiltration',
     'SignedDistanceFiltration',
+    'DensityFiltration'
     ]