org.expasy.mzjava.core.ms.spectrasim

Interface SimFunc<X extends PeakAnnotation,Y extends PeakAnnotation>

All Known Implementing Classes:

AbstractSimFunc, DpSimFunc, McNdpSimFunc, NdpSimFunc, PearsonsSimFunc, PspcSimFunc, SharedPeakSimFunc, WeightedPearsonsSimFunc

public interface SimFunc<X extends PeakAnnotation,Y extends PeakAnnotation>

Interface for any class that can calculate the similarity between two PeakLists

Version:

1.0

Author:

Oliver Horlacher

Method Summary

Methods

Modifier and Type	Method and Description
double	calcSimilarity(PeakList<X> plX, PeakList<Y> plY) Calculate the similarity score of the two vectors.
double	getBestScore() Return the best score that can be returned by calls to calcSimilarity.
int	getTotalPeakCount() Returns the total number peaks in plX and plY from the last call to calcSimilarity
double	getWorstScore() Return the worst the score that can be returned by calls to calcSimilarity.

Method Detail

calcSimilarity

double calcSimilarity(PeakList<X> plX,
                    PeakList<Y> plY)

Calculate the similarity score of the two vectors. Returns the similarity score or NaN if the score cannot be calculated

Parameters:

plX - the fist peak list

plY - the second peak list

Returns:

the similarity score or NaN if the score cannot be calculated

getTotalPeakCount

int getTotalPeakCount()

Returns the total number peaks in plX and plY from the last call to calcSimilarity

Returns:

the total number peaks in plX and plY from the last call to calcSimilarity

getBestScore

double getBestScore()

Return the best score that can be returned by calls to calcSimilarity. For similarity functions for which the best score has no upper limit Double.POSITIVE_INFINITY is returned and where the best score has no lower limit Double.NEGATIVE_INFINITY is returned.

Returns:

the best score that can be returned by calls to calcSimilarity

getWorstScore

double getWorstScore()

Return the worst the score that can be returned by calls to calcSimilarity. For similarity functions for which the worst score has no upper limit Double.POSITIVE_INFINITY is returned and where the worst score has no lower limit Double.NEGATIVE_INFINITY is returned.

Returns:

the worst score that can be returned by calls to calcSimilarity