Aligns the peaks of two spectra. More...
#include <OpenMS/COMPARISON/SPECTRA/SpectrumAlignment.h>
Inheritance diagram for SpectrumAlignment:
Public Member Functions | |
| template<typename SpectrumType > | |
| void | getSpectrumAlignment (std::vector< std::pair< Size, Size > > &alignment, const SpectrumType &s1, const SpectrumType &s2) const |
| SpectrumAlignment () | |
| default constructor | |
| SpectrumAlignment (const SpectrumAlignment &source) | |
| copy constructor | |
| virtual | ~SpectrumAlignment () |
| destructor | |
| SpectrumAlignment & | operator= (const SpectrumAlignment &source) |
| assignment operator | |
Detailed Description
Aligns the peaks of two spectra.
Using a banded (width via 'tolerance' parameter) alignment. Scoring function is the m/z distance between peaks. Intensity does not play a role!
Parameters of this class are:| Name | Type | Default | Restrictions | Description |
|---|---|---|---|---|
| tolerance | float | 0.3 | Defines the absolute (in Da) or relative (in ppm) tolerance | |
| is_relative_tolerance | string | false | true, false | If true, the 'tolerance' is interpreted as ppm-value |
Note:
- If a section name is documented, the documentation is displayed as tooltip.
- Advanced parameter names are italic.
Constructor & Destructor Documentation
default constructor
| SpectrumAlignment | ( | const SpectrumAlignment & | source | ) |
copy constructor
| virtual ~SpectrumAlignment | ( | ) | [virtual] |
destructor
Member Function Documentation
| void getSpectrumAlignment | ( | std::vector< std::pair< Size, Size > > & | alignment, | |
| const SpectrumType & | s1, | |||
| const SpectrumType & | s2 | |||
| ) | const [inline] |
Referenced by SpectraMerger::mergeSpectra_().
| SpectrumAlignment& operator= | ( | const SpectrumAlignment & | source | ) |
assignment operator
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:51 using doxygen 1.7.1 |