gudhi.representations.preprocessing.DiagramSelector Class Reference

Public Member Functions

def __init__ (self, use=False, limit=np.inf, point_type="finite")
 
def fit (self, X, y=None)
 
def transform (self, X)
 
def __call__ (self, diag)
 

Detailed Description

This is a class for extracting finite or essential points in persistence diagrams.

Constructor & Destructor Documentation

◆ __init__()

def gudhi.representations.preprocessing.DiagramSelector.__init__ (   self,
  use = False,
  limit = np.inf,
  point_type = "finite" 
)
Constructor for the DiagramSelector class.

Parameters:
    use (bool): whether to use the class or not (default False).
    limit (double): second coordinate value that is the criterion for being an essential point (default numpy.inf).
    point_type (string): either "finite" or "essential". The type of the points that are going to be extracted.

Member Function Documentation

◆ __call__()

def gudhi.representations.preprocessing.DiagramSelector.__call__ (   self,
  diag 
)
Apply DiagramSelector on a single persistence diagram and outputs the result.

Parameters:
    diag (n x 2 numpy array): input persistence diagram.

Returns:
    n x 2 numpy array: extracted persistence diagram.

◆ fit()

def gudhi.representations.preprocessing.DiagramSelector.fit (   self,
  X,
  y = None 
)
Fit the DiagramSelector class on a list of persistence diagrams (this function actually does nothing but is useful when DiagramSelector is included in a scikit-learn Pipeline).

Parameters:
    X (list of n x 2 or n x 1 numpy arrays): input persistence diagrams.
    y (n x 1 array): persistence diagram labels (unused).

◆ transform()

def gudhi.representations.preprocessing.DiagramSelector.transform (   self,
  X 
)
Extract and return the finite or essential points of each persistence diagram individually.

Parameters:
    X (list of n x 2 or n x 1 numpy arrays): input persistence diagrams.

Returns:
    list of n x 2 or n x 1 numpy arrays: extracted persistence diagrams.

The documentation for this class was generated from the following file:
GUDHI  Version 3.3.0  - C++ library for Topological Data Analysis (TDA) and Higher Dimensional Geometry Understanding.  - Copyright : MIT Generated on Tue Aug 11 2020 11:58:59 for GUDHI by Doxygen 1.8.18