ProteoWizard
PeakFamilyDetectorFT.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 _PEAKFAMILYDETECTORFT_HPP_
25 #define _PEAKFAMILYDETECTORFT_HPP_
26 
27 
29 #include "PeakFamilyDetector.hpp"
31 
32 
33 namespace pwiz {
34 namespace analysis {
35 
36 
37 ///
38 /// FT-specific implementation of PeakFamilyDetector
39 ///
41 {
42  public:
43 
45  {
46  std::ostream* log;
48  Config() : log(0) {}
49  };
50 
51  PeakFamilyDetectorFT(const Config& config);
52 
53  /// find peak families in a specified array of MZIntensityPair
54  virtual void detect(const MZIntensityPair* begin,
55  const MZIntensityPair* end,
56  std::vector<PeakFamily>& result);
57 
58  /// FT-specific exception
59  struct NoDataException : public std::runtime_error
60  {
61  NoDataException() : std::runtime_error("[PeakFamilyDetectorFT::NoDataException]") {}
62  };
63 
64  private:
65  class Impl;
66  boost::shared_ptr<Impl> impl_;
69 };
70 
71 
72 } // namespace analysis
73 } // namespace pwiz
74 
75 
76 #endif // _PEAKFAMILYDETECTORFT_HPP_
77 
pwiz::data::CalibrationParameters
Definition: CalibrationParameters.hpp:46
pwiz
Definition: ChromatogramList_Filter.hpp:36
pwiz::analysis::PeakFamilyDetectorFT::NoDataException
FT-specific exception.
Definition: PeakFamilyDetectorFT.hpp:60
PWIZ_API_DECL
#define PWIZ_API_DECL
Definition: Export.hpp:32
pwiz::analysis::PeakFamilyDetectorFT::NoDataException::NoDataException
NoDataException()
Definition: PeakFamilyDetectorFT.hpp:61
pwiz::analysis::PeakFamilyDetectorFT::Config
Definition: PeakFamilyDetectorFT.hpp:45
Export.hpp
pwiz::analysis::PeakFamilyDetectorFT::Config::log
std::ostream * log
Definition: PeakFamilyDetectorFT.hpp:46
pwiz::analysis::PeakFamilyDetector
interface for peak family (isotope envelope) detection
Definition: PeakFamilyDetector.hpp:41
pwiz::analysis::PeakFamilyDetectorFT::operator=
PeakFamilyDetectorFT & operator=(PeakFamilyDetectorFT &)
pwiz::analysis::PeakFamilyDetectorFT::Config::Config
Config()
Definition: PeakFamilyDetectorFT.hpp:48
PeakData.hpp
pwiz::analysis::PeakFamilyDetectorFT::impl_
boost::shared_ptr< Impl > impl_
Definition: PeakFamilyDetectorFT.hpp:65
pwiz::analysis::PeakFamilyDetectorFT::detect
virtual void detect(const MZIntensityPair *begin, const MZIntensityPair *end, std::vector< PeakFamily > &result)
find peak families in a specified array of MZIntensityPair
pwiz::analysis::PeakFamilyDetectorFT::PeakFamilyDetectorFT
PeakFamilyDetectorFT(PeakFamilyDetectorFT &)
pwiz::analysis::PeakFamilyDetectorFT::PeakFamilyDetectorFT
PeakFamilyDetectorFT(const Config &config)
pwiz::msdata::MZIntensityPair
The data point type of a mass spectrum.
Definition: MSData.hpp:423
pwiz::analysis::PeakFamilyDetectorFT
FT-specific implementation of PeakFamilyDetector.
Definition: PeakFamilyDetectorFT.hpp:41
pwiz::analysis::PeakFamilyDetectorFT::Config::cp
data::CalibrationParameters cp
Definition: PeakFamilyDetectorFT.hpp:47
PeakFamilyDetector.hpp