Inheritance diagram for frsutils.core.similarities.GaussianSimilarity:

Collaboration diagram for frsutils.core.similarities.GaussianSimilarity:

Public Member Functions
	__init__ (self, float sigma=0.1)

np.ndarray	compute (self, np.ndarray diff)

Public Member Functions inherited from frsutils.core.similarities.SimilarityFunction
np.ndarray	__call__ (self, np.ndarray diff)

Data Fields
	sigma = sigma

Detailed Description

Gaussian similarity: sim = exp(-diff^2 / (2 * sigma^2))

@param sigma: Standard deviation for the Gaussian kernel (must be > 0)

Definition at line 39 of file similarities.py.

Constructor & Destructor Documentation

◆ init()

frsutils.core.similarities.GaussianSimilarity.__init__	(		self,
		float	sigma = 0.1 )

Definition at line 45 of file similarities.py.

    def __init__(self, sigma: float = 0.1):
        # if not (0 < sigma <= 0.5):
        #     raise ValueError("sigma must be in the range (0, 0.5]")
        self.sigma = sigma
 

Member Function Documentation

◆ compute()

np.ndarray frsutils.core.similarities.GaussianSimilarity.compute	(		self,
		np.ndarray	diff )

Reimplemented from frsutils.core.similarities.SimilarityFunction.

Definition at line 50 of file similarities.py.

    def compute(self, diff: np.ndarray) -> np.ndarray:
       result = np.exp(-(diff ** 2) / (2.0 * self.sigma ** 2))
       return result
 
# ------------------------------------------------------------------------------
# Similarity Matrix Computation
# ------------------------------------------------------------------------------
 

References sigma.

Field Documentation

◆ sigma

frsutils.core.similarities.GaussianSimilarity.sigma = sigma

Definition at line 48 of file similarities.py.

Referenced by compute().

The documentation for this class was generated from the following file:

core/similarities.py

Public Member Functions

Data Fields