ProteoWizard
PeakFamilyDetector.hpp
Go to the documentation of this file.
1//
2// $Id$
3//
4//
5// Original author: Darren Kessner <darren@proteowizard.org>
6//
7// Copyright 2008 Spielberg Family Center for Applied Proteomics
8// Cedars-Sinai Medical Center, Los Angeles, California 90048
9//
10// Licensed under the Apache License, Version 2.0 (the "License");
11// you may not use this file except in compliance with the License.
12// You may obtain a copy of the License at
13//
14// http://www.apache.org/licenses/LICENSE-2.0
15//
16// Unless required by applicable law or agreed to in writing, software
17// distributed under the License is distributed on an "AS IS" BASIS,
18// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19// See the License for the specific language governing permissions and
20// limitations under the License.
21//
22
23
24#ifndef _PEAKFAMILYDETECTOR_HPP_
25#define _PEAKFAMILYDETECTOR_HPP_
26
27
31
32
33namespace pwiz {
34namespace analysis {
35
36
37///
38/// interface for peak family (isotope envelope) detection
39///
41{
42 public:
43
46
47 /// find peak families in a specified array of MZIntensityPair
48 virtual void detect(const MZIntensityPair* begin,
49 const MZIntensityPair* end,
50 std::vector<PeakFamily>& result) = 0;
51
52 /// convenience function -- equivalent to:
53 /// detect(&data[0], &data[0]+data.size(), result)
54 virtual void detect(const std::vector<MZIntensityPair>& data,
55 std::vector<PeakFamily>& result);
56
57 virtual ~PeakFamilyDetector() {}
58};
59
60
61} // namespace analysis
62} // namespace pwiz
63
64
65#endif // _PEAKFAMILYDETECTOR_HPP_
66
#define PWIZ_API_DECL
Definition Export.hpp:32
interface for peak family (isotope envelope) detection
pwiz::data::peakdata::PeakFamily PeakFamily
virtual void detect(const MZIntensityPair *begin, const MZIntensityPair *end, std::vector< PeakFamily > &result)=0
find peak families in a specified array of MZIntensityPair
pwiz::msdata::MZIntensityPair MZIntensityPair
virtual void detect(const std::vector< MZIntensityPair > &data, std::vector< PeakFamily > &result)
convenience function – equivalent to: detect(&data[0], &data[0]+data.size(), result)
The data point type of a mass spectrum.
Definition MSData.hpp:423