Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Private Attributes | List of all members
EuclideanSimilarity Class Reference

CompareFunctor for 2Dpoints. More...

#include <OpenMS/COMPARISON/CLUSTERING/EuclideanSimilarity.h>

Public Member Functions

 EuclideanSimilarity ()
 default constructor More...
 
 EuclideanSimilarity (const EuclideanSimilarity &source)
 copy constructor More...
 
virtual ~EuclideanSimilarity ()
 destructor More...
 
EuclideanSimilarityoperator= (const EuclideanSimilarity &source)
 assignment operator More...
 
Real operator() (const std::pair< Real, Real > &a, const std::pair< Real, Real > &b) const
 calculates similarity between two points in euclidean space More...
 
Real operator() (const std::pair< Real, Real > &c) const
 calculates self similarity, will yield 0 More...
 
void setScale (Real x)
 clusters the indices according to their respective element distances More...
 

Private Attributes

Real scale_
 

Detailed Description

CompareFunctor for 2Dpoints.

each 2D point as a pair of Real holds a Real coordinate for each Dimension

Constructor & Destructor Documentation

default constructor

copy constructor

virtual ~EuclideanSimilarity ( )
virtual

destructor

Member Function Documentation

Real operator() ( const std::pair< Real, Real > &  a,
const std::pair< Real, Real > &  b 
) const

calculates similarity between two points in euclidean space

Parameters
aa pair of Real, giving the x and the y coordinates of the first point
ba pair of Real, giving the x and the y coordinates of the second point

calculates similarity from the euclidean distance between given 2D points, scaled in [0,1]

See Also
setScale
Real operator() ( const std::pair< Real, Real > &  c) const

calculates self similarity, will yield 0

Parameters
ca pair of Real, giving the x and the y coordinates
EuclideanSimilarity& operator= ( const EuclideanSimilarity source)

assignment operator

void setScale ( Real  x)

clusters the indices according to their respective element distances

Parameters
xReal value to scale the result
Exceptions
Exception::DivisionByZeroif scaling is unapplicable because it is 0

sets the scale so that similarities can be correctly calculated from distances. Should be set so that the greatest distance in a chosen set will be scales to 1 (i.e. x = greatest possible distance in the set)

Member Data Documentation

Real scale_
private

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:28 using doxygen 1.8.5