summaryrefslogtreecommitdiff
path: root/src/python/gudhi/representations/vector_methods.py
diff options
context:
space:
mode:
authorGard Spreemann <gspr@nonempty.org>2021-05-16 14:21:05 +0200
committerGard Spreemann <gspr@nonempty.org>2021-05-16 14:21:05 +0200
commit241cc1422e9362c23db1c4c25ba8b63f88a1153f (patch)
treeb654d5f4478839e5752b745fae3228a25b7fabba /src/python/gudhi/representations/vector_methods.py
parentcb01ba2a8fa4aba9dc27b9dc62eaaf492150cad0 (diff)
Update doc string to reflect new class name
Diffstat (limited to 'src/python/gudhi/representations/vector_methods.py')
-rw-r--r--src/python/gudhi/representations/vector_methods.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/python/gudhi/representations/vector_methods.py b/src/python/gudhi/representations/vector_methods.py
index bdbaa175..7e615b70 100644
--- a/src/python/gudhi/representations/vector_methods.py
+++ b/src/python/gudhi/representations/vector_methods.py
@@ -290,7 +290,7 @@ class Silhouette(BaseEstimator, TransformerMixin):
class BettiCurve(BaseEstimator, TransformerMixin):
"""
- A more flexible replacement for the BettiCurve class. There are two modes of operation: with a predefined grid, and without. With a predefined grid, the class computes the Betti numbers at those grid points. Without a predefined grid, it can be fit to a list of persistence diagrams and produce a grid that consists of (at least) the filtration values at which at least one of those persistence diagrams chance Betti numbers, and then compute the Betti numbers at those grid points. In the latter mode, the exact Betti curve is computed for the entire real line.
+ Compute Betti curves from persistence diagrams. There are two modes of operation: with a predefined grid, and without. With a predefined grid, the class computes the Betti numbers at those grid points. Without a predefined grid, it can be fit to a list of persistence diagrams and produce a grid that consists of (at least) the filtration values at which at least one of those persistence diagrams chance Betti numbers, and then compute the Betti numbers at those grid points. In the latter mode, the exact Betti curve is computed for the entire real line.
Parameters
----------
@@ -305,11 +305,11 @@ class BettiCurve(BaseEstimator, TransformerMixin):
Examples
--------
If pd is a persistence diagram and xs is a nonempty grid of finite values such that xs[0] >= pd.min(), then the result of
- >>> bc = BettiCurve2(xs)
+ >>> bc = BettiCurve(xs)
>>> result = bc(pd)
and
>>> from scipy.interpolate import interp1d
- >>> bc = BettiCurve2(None)
+ >>> bc = BettiCurve(None)
>>> bettis = bc.fit_transform([pd])
>>> interp = interp1d(bc.grid_, bettis[0, :], kind="previous", fill_value="extrapolate")
>>> result = np.array(interp(xs), dtype=int)