A 2-dimensional raw data point or peak. More...
#include <OpenMS/KERNEL/Peak2D.h>
Classes | |
struct | IntensityLess |
struct | MZLess |
Comparator by m/z position. More... | |
struct | PositionLess |
Comparator by position. Lexicographical comparison (first RT then m/z) is done. More... | |
struct | RTLess |
Comparator by RT position. More... | |
Public Types | |
Type definitions | |
typedef Real | IntensityType |
Intensity type. More... | |
typedef DoubleReal | CoordinateType |
Coordinate type (of the position) More... | |
typedef DPosition< 2 > | PositionType |
Position type. More... | |
Public Member Functions | |
Peak2D & | operator= (const Peak2D &rhs) |
Assignment operator. More... | |
bool | operator== (const Peak2D &rhs) const |
Equality operator. More... | |
bool | operator!= (const Peak2D &rhs) const |
Equality operator. More... | |
Constructors and Destructor | |
Default constructor | |
Peak2D () | |
Peak2D (const Peak2D &p) | |
Copy constructor. More... | |
~Peak2D () | |
Destructor. More... | |
Accessors | |
Non-mutable access to the data point intensity (height) | |
IntensityType | getIntensity () const |
void | setIntensity (IntensityType intensity) |
Non-mutable access to the data point intensity (height) More... | |
PositionType const & | getPosition () const |
Non-mutable access to the position. More... | |
PositionType & | getPosition () |
Mutable access to the position. More... | |
void | setPosition (const PositionType &position) |
Mutable access to the position. More... | |
CoordinateType | getMZ () const |
Returns the m/z coordinate (index 1) More... | |
void | setMZ (CoordinateType coordinate) |
Mutable access to the m/z coordinate (index 1) More... | |
CoordinateType | getRT () const |
Returns the RT coordinate (index 0) More... | |
void | setRT (CoordinateType coordinate) |
Mutable access to the RT coordinate (index 0) More... | |
Protected Attributes | |
PositionType | position_ |
The data point position. More... | |
IntensityType | intensity_ |
The data point intensity. More... | |
Friends | |
std::ostream & | operator<< (std::ostream &os, const Peak2D &point) |
Print the contents to a stream. More... | |
Dimension descriptions | |
enum | DimensionDescription { RT = 0, MZ = 1, DIMENSION = 2 } |
This enum maps the symbolic names of the dimensions to numbers. More... | |
static char const *const | dimension_name_short_ [DIMENSION] |
Short name of the dimension (abbreviated form) More... | |
static char const *const | dimension_name_full_ [DIMENSION] |
Full name of the dimension (self-explanatory form) More... | |
static char const *const | dimension_unit_short_ [DIMENSION] |
Unit of measurement (abbreviated form) More... | |
static char const *const | dimension_unit_full_ [DIMENSION] |
Unit of measurement (self-explanatory form) More... | |
static char const * | shortDimensionName (UInt const dim) |
Short name of the dimension (abbreviated form) More... | |
static char const * | shortDimensionNameRT () |
Short name of the dimension (abbreviated form) More... | |
static char const * | shortDimensionNameMZ () |
Short name of the dimension (abbreviated form) More... | |
static char const * | fullDimensionName (UInt const dim) |
Full name of the dimension (self-explanatory form) More... | |
static char const * | fullDimensionNameRT () |
Full name of the dimension (self-explanatory form) More... | |
static char const * | fullDimensionNameMZ () |
Full name of the dimension (self-explanatory form) More... | |
static char const * | shortDimensionUnit (UInt const dim) |
Unit of measurement (abbreviated form) More... | |
static char const * | shortDimensionUnitRT () |
Unit of measurement (abbreviated form) More... | |
static char const * | shortDimensionUnitMZ () |
Unit of measurement (abbreviated form) More... | |
static char const * | fullDimensionUnit (UInt const dim) |
Unit of measurement (self-explanatory form) More... | |
static char const * | fullDimensionUnitRT () |
Unit of measurement (self-explanatory form) More... | |
static char const * | fullDimensionUnitMZ () |
Unit of measurement (self-explanatory form) More... | |
A 2-dimensional raw data point or peak.
This datastructure is intended for continuous data or peak data. If wou want to annotated single peaks with meta data, use RichPeak2D instead.
typedef DoubleReal CoordinateType |
Coordinate type (of the position)
typedef Real IntensityType |
Intensity type.
typedef DPosition<2> PositionType |
Position type.
enum DimensionDescription |
|
inline |
|
inline |
|
static |
Full name of the dimension (self-explanatory form)
|
static |
Full name of the dimension (self-explanatory form)
|
static |
Full name of the dimension (self-explanatory form)
|
static |
Unit of measurement (self-explanatory form)
|
static |
Unit of measurement (self-explanatory form)
|
static |
Unit of measurement (self-explanatory form)
|
inline |
Referenced by FeatureFinderAlgorithmPicked< PeakType, FeatureType >::extendMassTraces_(), OpenMS::intensityAscendingComparator(), OpenMS::intensityComparator(), OpenMS::intensityPointerComparator(), Peak2D::IntensityLess::operator()(), InIntensityRange< PeakType >::operator()(), MRMTransitionGroupPicker::pickTransitionGroup(), FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run(), and EGHTraceFitter< PeakType >::setInitialParameters_().
|
inline |
Returns the m/z coordinate (index 1)
Referenced by FeatureFinderAlgorithmPicked< PeakType, FeatureType >::extendMassTraces_(), ModelFitter< PeakType, FeatureType >::fit(), KroenikFile::load(), SpectraMerger::SpectraDistance_::operator()(), Peak2D::MZLess::operator()(), OpenMS::positionComparator(), FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run(), FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run(), and FeatureFinderAlgorithmPicked< PeakType, FeatureType >::writeFeatureDebugInfo_().
|
inline |
Non-mutable access to the position.
Referenced by Peak2D::PositionLess::operator()(), and InMzRange< PeakType >::operator()().
|
inline |
Mutable access to the position.
|
inline |
Returns the RT coordinate (index 0)
Referenced by IDMapper::annotate(), MRMFeatureFinderScoring::calculateSwathScores_(), ModelFitter< PeakType, FeatureType >::fit(), SpectraMerger::SpectraDistance_::operator()(), PrecursorIonSelection::SeqTotalScoreMore::operator()(), Peak2D::RTLess::operator()(), and FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run().
|
inline |
Equality operator.
Assignment operator.
References Peak2D::intensity_, and Peak2D::position_.
Referenced by RichPeak2D::operator=(), and FeatureHandle::operator=().
|
inline |
Equality operator.
References Peak2D::intensity_, and Peak2D::position_.
Referenced by RichPeak2D::operator==().
|
inline |
Non-mutable access to the data point intensity (height)
Referenced by FeatureFinderAlgorithmIsotopeWavelet< OpenMS::Peak2D, FeatureType >::createHRData(), MRMTransitionGroupPicker::createMRMFeature(), ThresholdMower::filterSpectrum(), ModelFitter< PeakType, FeatureType >::fit(), MsInspectFile::load(), SpecArrayFile::load(), KroenikFile::load(), XMassFile::load(), IsotopeWaveletTransform< PeakType >::mapSeeds2Features(), PeakPickerSH::pick(), PeakPickerHiRes::pick(), FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run(), and FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run().
|
inline |
Mutable access to the m/z coordinate (index 1)
Referenced by ChromatogramTools::convertChromatogramsToSpectra(), FeatureFinderAlgorithmIsotopeWavelet< OpenMS::Peak2D, FeatureType >::createHRData(), MRMTransitionGroupPicker::createMRMFeature(), ModelFitter< PeakType, FeatureType >::fit(), MsInspectFile::load(), SpecArrayFile::load(), KroenikFile::load(), IsotopeWaveletTransform< PeakType >::mapSeeds2Features(), SpectraMerger::mergeSpectraPrecursors(), PeakPickerSH::pick(), PeakPickerHiRes::pick(), FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run(), and FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run().
|
inline |
Mutable access to the position.
Referenced by MascotInfile::load(), XMassFile::load(), DBAdapter::loadSpectrum(), and FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run().
|
inline |
Mutable access to the RT coordinate (index 0)
Referenced by ChromatogramTools::convertSpectraToChromatograms(), MRMTransitionGroupPicker::createMRMFeature(), ModelFitter< PeakType, FeatureType >::fit(), MsInspectFile::load(), SpecArrayFile::load(), KroenikFile::load(), IsotopeWaveletTransform< PeakType >::mapSeeds2Features(), SpectraMerger::mergeSpectraPrecursors(), FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run(), and FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run().
|
static |
Short name of the dimension (abbreviated form)
Referenced by ProductModel< 2 >::ProductModel(), ProductModel< 2 >::setModel(), and ProductModel< 2 >::updateMembers_().
|
static |
Short name of the dimension (abbreviated form)
|
static |
Short name of the dimension (abbreviated form)
|
static |
Unit of measurement (abbreviated form)
|
static |
Unit of measurement (abbreviated form)
|
static |
Unit of measurement (abbreviated form)
|
friend |
Print the contents to a stream.
|
staticprotected |
Full name of the dimension (self-explanatory form)
|
staticprotected |
Short name of the dimension (abbreviated form)
|
staticprotected |
Unit of measurement (self-explanatory form)
|
staticprotected |
Unit of measurement (abbreviated form)
|
protected |
The data point intensity.
Referenced by Peak2D::operator=(), and Peak2D::operator==().
|
protected |
The data point position.
Referenced by Peak2D::operator=(), and Peak2D::operator==().
OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:32 using doxygen 1.8.5 |