ProteoWizard
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet Class Reference

#include <SpectrumList_Filter.hpp>

Inheritance diagram for pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet:
pwiz::analysis::SpectrumList_Filter::Predicate

Public Types

enum  TargetMode { TargetMode_Selected, TargetMode_Isolated }
 
- Public Types inherited from pwiz::analysis::SpectrumList_Filter::Predicate
enum  FilterMode { FilterMode_Include, FilterMode_Exclude }
 controls whether spectra that pass the predicate are included or excluded from the result More...
 

Public Member Functions

 SpectrumList_FilterPredicate_PrecursorMzSet (const std::set< double > &precursorMzSet, chemistry::MZTolerance tolerance, FilterMode mode, TargetMode target=TargetMode_Selected)
 
virtual boost::logic::tribool accept (const msdata::SpectrumIdentity &spectrumIdentity) const
 return values: true: accept the Spectrum false: reject the Spectrum indeterminate: need to see the full Spectrum object to decide More...
 
virtual boost::logic::tribool accept (const msdata::Spectrum &spectrum) const
 return true iff Spectrum is accepted More...
 
virtual std::string describe () const
 return a string describing how the predicate filters More...
 
- Public Member Functions inherited from pwiz::analysis::SpectrumList_Filter::Predicate
virtual msdata::DetailLevel suggestedDetailLevel () const
 can be overridden in subclasses that know they will need a certain detail level; it must be overridden to return DetailLevel_FullData if binary data is needed More...
 
virtual bool done () const
 return true iff done accepting spectra; this allows early termination of the iteration through the original SpectrumList, possibly using assumptions about the order of the iteration (e.g. More...
 
virtual ~Predicate ()
 

Private Member Functions

double getPrecursorMz (const msdata::Spectrum &spectrum) const
 

Private Attributes

std::set< double > precursorMzSet_
 
chemistry::MZTolerance tolerance_
 
FilterMode mode_
 
TargetMode target_
 

Detailed Description

Definition at line 201 of file SpectrumList_Filter.hpp.

Member Enumeration Documentation

◆ TargetMode

Enumerator
TargetMode_Selected 
TargetMode_Isolated 

Definition at line 205 of file SpectrumList_Filter.hpp.

206  {
209  };

Constructor & Destructor Documentation

◆ SpectrumList_FilterPredicate_PrecursorMzSet()

pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet::SpectrumList_FilterPredicate_PrecursorMzSet ( const std::set< double > &  precursorMzSet,
chemistry::MZTolerance  tolerance,
FilterMode  mode,
TargetMode  target = TargetMode_Selected 
)

Member Function Documentation

◆ accept() [1/2]

virtual boost::logic::tribool pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet::accept ( const msdata::SpectrumIdentity spectrumIdentity) const
inlinevirtual

return values: true: accept the Spectrum false: reject the Spectrum indeterminate: need to see the full Spectrum object to decide

Implements pwiz::analysis::SpectrumList_Filter::Predicate.

Definition at line 212 of file SpectrumList_Filter.hpp.

212 {return boost::logic::indeterminate;}

◆ accept() [2/2]

virtual boost::logic::tribool pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet::accept ( const msdata::Spectrum spectrum) const
virtual

return true iff Spectrum is accepted

Reimplemented from pwiz::analysis::SpectrumList_Filter::Predicate.

◆ describe()

virtual std::string pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet::describe ( ) const
inlinevirtual

return a string describing how the predicate filters

Implements pwiz::analysis::SpectrumList_Filter::Predicate.

Definition at line 214 of file SpectrumList_Filter.hpp.

214 { return "set of precursor M/Zs"; }

◆ getPrecursorMz()

double pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet::getPrecursorMz ( const msdata::Spectrum spectrum) const
private

Member Data Documentation

◆ precursorMzSet_

std::set<double> pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet::precursorMzSet_
private

Definition at line 217 of file SpectrumList_Filter.hpp.

◆ tolerance_

chemistry::MZTolerance pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet::tolerance_
private

Definition at line 218 of file SpectrumList_Filter.hpp.

◆ mode_

FilterMode pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet::mode_
private

Definition at line 219 of file SpectrumList_Filter.hpp.

◆ target_

TargetMode pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet::target_
private

Definition at line 220 of file SpectrumList_Filter.hpp.


The documentation for this class was generated from the following file:
pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet::TargetMode_Isolated
@ TargetMode_Isolated
Definition: SpectrumList_Filter.hpp:208
pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet::TargetMode_Selected
@ TargetMode_Selected
Definition: SpectrumList_Filter.hpp:207