ProteoWizard
SpectrumList_PeakFilter.hpp
Go to the documentation of this file.
1 //
2 // $Id$
3 //
4 //
5 // Original author: Matt Chambers <matt.chambers <a.t> vanderbilt.edu>
6 //
7 // Copyright 2008 Vanderbilt University - Nashville, TN 37232
8 //
9 // Licensed under the Apache License, Version 2.0 (the "License");
10 // you may not use this file except in compliance with the License.
11 // You may obtain a copy of the License at
12 //
13 // http://www.apache.org/licenses/LICENSE-2.0
14 //
15 // Unless required by applicable law or agreed to in writing, software
16 // distributed under the License is distributed on an "AS IS" BASIS,
17 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 // See the License for the specific language governing permissions and
19 // limitations under the License.
20 //
21 
22 
23 #ifndef _SPECTRUMLIST_PEAKFILTER_HPP_
24 #define _SPECTRUMLIST_PEAKFILTER_HPP_
25 
26 
27 #include <boost/scoped_ptr.hpp>
30 
31 
32 namespace pwiz {
33 namespace analysis {
34 
35 /// SpectrumList implementation that returns spectra with the specified SpectrumDataFilter operation applied
37 {
38  public:
39 
41  SpectrumDataFilterPtr filterFunctor);
42 
43  /// peak filters work on any SpectrumList
44  static bool accept(const msdata::SpectrumListPtr& inner) {return true;}
45 
46  virtual msdata::SpectrumPtr spectrum(size_t index, bool getBinaryData = false) const;
48 
49  private:
51 };
52 
53 
54 
56 {
60 
61  public:
62 
63  IsolationWindowFilter(double defaultWindowWidth, const msdata::SpectrumListPtr& sl);
64  IsolationWindowFilter(double defaultWindowWidth, const msdata::IsolationWindow& window);
65 
66  virtual void operator () (const pwiz::msdata::SpectrumPtr&) const;
67  virtual void describe(pwiz::msdata::ProcessingMethod&) const {}
68 };
69 
70 } // namespace analysis
71 } // namespace pwiz
72 
73 
74 #endif // _SPECTRUMLIST_PEAKFILTER_HPP_
pwiz::msdata::IsolationWindow
This element captures the isolation (or 'selection') window configured to isolate one or more precurs...
Definition: MSData.hpp:292
pwiz::msdata::SpectrumListPtr
boost::shared_ptr< SpectrumList > SpectrumListPtr
Definition: MSData.hpp:711
pwiz
Definition: ChromatogramList_Filter.hpp:36
pwiz::msdata::ProcessingMethod
Description of the default peak processing method. This element describes the base method used in the...
Definition: MSData.hpp:255
pwiz::msdata::SpectrumListWrapper
Inheritable pass-through implementation for wrapping a SpectrumList.
Definition: SpectrumListWrapper.hpp:38
pwiz::analysis::IsolationWindowFilter::describe
virtual void describe(pwiz::msdata::ProcessingMethod &) const
Definition: SpectrumList_PeakFilter.hpp:67
pwiz::analysis::IsolationWindowFilter
Definition: SpectrumList_PeakFilter.hpp:56
DataFilter.hpp
pwiz::analysis::SpectrumList_PeakFilter::spectrum
virtual msdata::SpectrumPtr spectrum(size_t index, bool getBinaryData=false) const
retrieve a spectrum by index
PWIZ_API_DECL
#define PWIZ_API_DECL
Definition: Export.hpp:32
pwiz::msdata::DetailLevel_FullMetadata
@ DetailLevel_FullMetadata
Definition: MSData.hpp:634
pwiz::analysis::SpectrumList_PeakFilter::accept
static bool accept(const msdata::SpectrumListPtr &inner)
peak filters work on any SpectrumList
Definition: SpectrumList_PeakFilter.hpp:44
pwiz::analysis::SpectrumList_PeakFilter::SpectrumList_PeakFilter
SpectrumList_PeakFilter(const msdata::SpectrumListPtr &inner, SpectrumDataFilterPtr filterFunctor)
pwiz::analysis::SpectrumList_PeakFilter::filterFunctor_
SpectrumDataFilterPtr filterFunctor_
Definition: SpectrumList_PeakFilter.hpp:50
pwiz::analysis::IsolationWindowFilter::spectrumList
msdata::SpectrumListPtr spectrumList
Definition: SpectrumList_PeakFilter.hpp:58
pwiz::msdata::SpectrumPtr
boost::shared_ptr< Spectrum > SpectrumPtr
Definition: MSData.hpp:573
pwiz::analysis::SpectrumDataFilter
Definition: DataFilter.hpp:36
pwiz::analysis::IsolationWindowFilter::window
msdata::IsolationWindow window
Definition: SpectrumList_PeakFilter.hpp:59
pwiz::analysis::SpectrumDataFilterPtr
boost::shared_ptr< SpectrumDataFilter > SpectrumDataFilterPtr
Definition: DataFilter.hpp:42
pwiz::analysis::IsolationWindowFilter::IsolationWindowFilter
IsolationWindowFilter(double defaultWindowWidth, const msdata::IsolationWindow &window)
pwiz::analysis::IsolationWindowFilter::defaultWindowWidth
double defaultWindowWidth
Definition: SpectrumList_PeakFilter.hpp:57
pwiz::msdata::DetailLevel
DetailLevel
Definition: MSData.hpp:631
pwiz::analysis::IsolationWindowFilter::IsolationWindowFilter
IsolationWindowFilter(double defaultWindowWidth, const msdata::SpectrumListPtr &sl)
pwiz::analysis::SpectrumList_PeakFilter
SpectrumList implementation that returns spectra with the specified SpectrumDataFilter operation appl...
Definition: SpectrumList_PeakFilter.hpp:37
pwiz::analysis::SpectrumList_PeakFilter::spectrum
virtual msdata::SpectrumPtr spectrum(size_t index, msdata::DetailLevel detailLevel=msdata::DetailLevel_FullMetadata) const
retrieve a spectrum by index
SpectrumListWrapper.hpp