gudhi.representations.preprocessing.Clamping Class Reference

Public Member Functions

def __init__ (self, minimum=-np.inf, maximum=np.inf)
 
def fit (self, X, y=None)
 
def transform (self, X)
 

Detailed Description

This is a class for clamping values. It can be used as a parameter for the DiagramScaler class, for instance if you want to clamp abscissae or ordinates of persistence diagrams.

Constructor & Destructor Documentation

◆ __init__()

def gudhi.representations.preprocessing.Clamping.__init__ (   self,
  minimum = -np.inf,
  maximum = np.inf 
)
Constructor for the Clamping class.

Parameters:
    limit (double): clamping value (default np.inf).

Member Function Documentation

◆ fit()

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

Parameters:
    X (numpy array of size n): input values.
    y (n x 1 array): value labels (unused).

◆ transform()

def gudhi.representations.preprocessing.Clamping.transform (   self,
  X 
)
Clamp list of values.

Parameters:
    X (numpy array of size n): input list of values.

Returns:
    numpy array of size n: output list of values.

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