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

#include <SpectrumList_Filter.hpp>

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

Public Member Functions

 SpectrumList_FilterPredicate_MzPresent (chemistry::MZTolerance mzt, std::set< double > mzSet, ThresholdFilter tf, FilterMode mode)
 
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
 
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
 
virtual boost::logic::tribool accept (const msdata::Spectrum &spectrum) const
 return true iff Spectrum is accepted
 
virtual std::string describe () const
 return a string describing how the predicate filters
 
- Public Member Functions inherited from pwiz::analysis::SpectrumList_Filter::Predicate
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.
 
virtual ~Predicate ()
 

Private Attributes

chemistry::MZTolerance mzt_
 
std::set< double > mzSet_
 
ThresholdFilter tf_
 
FilterMode mode_
 

Additional Inherited Members

- 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...
 

Detailed Description

Definition at line 280 of file SpectrumList_Filter.hpp.

Constructor & Destructor Documentation

◆ SpectrumList_FilterPredicate_MzPresent()

pwiz::analysis::SpectrumList_FilterPredicate_MzPresent::SpectrumList_FilterPredicate_MzPresent ( chemistry::MZTolerance  mzt,
std::set< double >  mzSet,
ThresholdFilter  tf,
FilterMode  mode 
)

Member Function Documentation

◆ suggestedDetailLevel()

virtual msdata::DetailLevel pwiz::analysis::SpectrumList_FilterPredicate_MzPresent::suggestedDetailLevel ( ) const
inlinevirtual

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

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

Definition at line 284 of file SpectrumList_Filter.hpp.

◆ accept() [1/2]

virtual boost::logic::tribool pwiz::analysis::SpectrumList_FilterPredicate_MzPresent::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 285 of file SpectrumList_Filter.hpp.

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

◆ accept() [2/2]

virtual boost::logic::tribool pwiz::analysis::SpectrumList_FilterPredicate_MzPresent::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_MzPresent::describe ( ) const
inlinevirtual

return a string describing how the predicate filters

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

Definition at line 287 of file SpectrumList_Filter.hpp.

287{ return "set of M/Zs in spectrum"; }

Member Data Documentation

◆ mzt_

chemistry::MZTolerance pwiz::analysis::SpectrumList_FilterPredicate_MzPresent::mzt_
private

Definition at line 290 of file SpectrumList_Filter.hpp.

◆ mzSet_

std::set<double> pwiz::analysis::SpectrumList_FilterPredicate_MzPresent::mzSet_
private

Definition at line 291 of file SpectrumList_Filter.hpp.

◆ tf_

ThresholdFilter pwiz::analysis::SpectrumList_FilterPredicate_MzPresent::tf_
private

Definition at line 292 of file SpectrumList_Filter.hpp.

◆ mode_

FilterMode pwiz::analysis::SpectrumList_FilterPredicate_MzPresent::mode_
private

Definition at line 293 of file SpectrumList_Filter.hpp.


The documentation for this class was generated from the following file: