Compare functor scoring the spectral contrast angle for similarity measurement. More...
#include <OpenMS/COMPARISON/SPECTRA/BinnedSpectralContrastAngle.h>
Public Member Functions | |
| BinnedSpectralContrastAngle () | |
| default constructor | |
| BinnedSpectralContrastAngle (const BinnedSpectralContrastAngle &source) | |
| copy constructor | |
| virtual | ~BinnedSpectralContrastAngle () |
| destructor | |
| BinnedSpectralContrastAngle & | operator= (const BinnedSpectralContrastAngle &source) |
| assignment operator | |
| double | operator() (const BinnedSpectrum &spec1, const BinnedSpectrum &spec2) const |
| double | operator() (const BinnedSpectrum &spec) const |
| function call operator, calculates self similarity | |
Static Public Member Functions | |
| static BinnedSpectrumCompareFunctor * | create () |
| static const String | getProductName () |
| get the identifier for this DefaultParamHandler | |
Detailed Description
Compare functor scoring the spectral contrast angle for similarity measurement.
The details of the score can be found in: K. Wan, I. Vidavsky, and M. Gross. Comparing similar spectra: from similarity index to spectral contrast angle. Journal of the American Society for Mass Spectrometry, 13(1):85-88, January 2002.
Parameters of this class are:| Name | Type | Default | Restrictions | Description |
|---|---|---|---|---|
| normalized | int | 1 | is set 1 if the similarity-measurement is normalized to the range [0,1] | |
| precursor_mass_tolerance | float | 3 | Mass tolerance of the precursor peak, defines the distance of two PrecursorPeaks for which they are supposed to be from different peptides |
Note:
- If a section name is documented, the documentation is displayed as tooltip.
- Advanced parameter names are italic.
Constructor & Destructor Documentation
default constructor
| BinnedSpectralContrastAngle | ( | const BinnedSpectralContrastAngle & | source | ) |
copy constructor
| virtual ~BinnedSpectralContrastAngle | ( | ) | [virtual] |
destructor
Member Function Documentation
| static BinnedSpectrumCompareFunctor* create | ( | ) | [inline, static] |
| static const String getProductName | ( | ) | [inline, static] |
get the identifier for this DefaultParamHandler
Reimplemented from BinnedSpectrumCompareFunctor.
| double operator() | ( | const BinnedSpectrum & | spec1, | |
| const BinnedSpectrum & | spec2 | |||
| ) | const [virtual] |
function call operator, calculates the similarity of the given arguments
- Parameters:
-
spec1 First spectrum given in a binned representation spec2 Second spectrum ginve in a binned representation
- Exceptions:
-
IncompatibleBinning is thrown if the binnings of the spectra are not the same
Implements BinnedSpectrumCompareFunctor.
| double operator() | ( | const BinnedSpectrum & | spec | ) | const [virtual] |
function call operator, calculates self similarity
Implements BinnedSpectrumCompareFunctor.
| BinnedSpectralContrastAngle& operator= | ( | const BinnedSpectralContrastAngle & | source | ) |
assignment operator
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:50 using doxygen 1.7.1 |