ProteoWizard
|
client-implemented filter predicate – called during construction of SpectrumList_Filter to create the filtered list of spectra More...
#include <SpectrumList_Filter.hpp>
Public Types | |
enum | FilterMode { FilterMode_Include , FilterMode_Exclude } |
controls whether spectra that pass the predicate are included or excluded from the result More... | |
Public Member Functions | |
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 =0 |
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 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 std::string | describe () const =0 |
return a string describing how the predicate filters | |
virtual | ~Predicate () |
client-implemented filter predicate – called during construction of SpectrumList_Filter to create the filtered list of spectra
Definition at line 50 of file SpectrumList_Filter.hpp.
controls whether spectra that pass the predicate are included or excluded from the result
Enumerator | |
---|---|
FilterMode_Include | |
FilterMode_Exclude |
Definition at line 53 of file SpectrumList_Filter.hpp.
|
inlinevirtual |
Definition at line 82 of file SpectrumList_Filter.hpp.
|
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 in pwiz::analysis::SpectrumList_FilterPredicate_MzPresent, and HasBinaryDataPredicate.
Definition at line 61 of file SpectrumList_Filter.hpp.
|
pure virtual |
return values: true: accept the Spectrum false: reject the Spectrum indeterminate: need to see the full Spectrum object to decide
Implemented in pwiz::analysis::SpectrumList_FilterPredicate_IndexSet, pwiz::analysis::SpectrumList_FilterPredicate_ScanNumberSet, pwiz::analysis::SpectrumList_FilterPredicate_IdSet, pwiz::analysis::SpectrumList_FilterPredicate_ScanEventSet, pwiz::analysis::SpectrumList_FilterPredicate_ScanTimeRange, pwiz::analysis::SpectrumList_FilterPredicate_MSLevelSet, pwiz::analysis::SpectrumList_FilterPredicate_ChargeStateSet, pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet, pwiz::analysis::SpectrumList_FilterPredicate_DefaultArrayLengthSet, pwiz::analysis::SpectrumList_FilterPredicate_ActivationType, pwiz::analysis::SpectrumList_FilterPredicate_AnalyzerType, pwiz::analysis::SpectrumList_FilterPredicate_Polarity, pwiz::analysis::SpectrumList_FilterPredicate_MzPresent, pwiz::analysis::SpectrumList_FilterPredicate_ThermoScanFilter, HasBinaryDataPredicate, EvenPredicate, EvenMS2Predicate, and SelectedIndexPredicate.
|
inlinevirtual |
return true iff Spectrum is accepted
Reimplemented in pwiz::analysis::SpectrumList_FilterPredicate_ScanEventSet, pwiz::analysis::SpectrumList_FilterPredicate_ScanTimeRange, pwiz::analysis::SpectrumList_FilterPredicate_MSLevelSet, pwiz::analysis::SpectrumList_FilterPredicate_ChargeStateSet, pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet, pwiz::analysis::SpectrumList_FilterPredicate_DefaultArrayLengthSet, pwiz::analysis::SpectrumList_FilterPredicate_ActivationType, pwiz::analysis::SpectrumList_FilterPredicate_AnalyzerType, pwiz::analysis::SpectrumList_FilterPredicate_Polarity, pwiz::analysis::SpectrumList_FilterPredicate_MzPresent, pwiz::analysis::SpectrumList_FilterPredicate_ThermoScanFilter, EvenMS2Predicate, and HasBinaryDataPredicate.
Definition at line 70 of file SpectrumList_Filter.hpp.
|
inlinevirtual |
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.
index is increasing, nativeID interpreted as scan number is increasing, ...)
Reimplemented in SelectedIndexPredicate, SelectedIndexPredicate, pwiz::analysis::SpectrumList_FilterPredicate_IndexSet, pwiz::analysis::SpectrumList_FilterPredicate_ScanNumberSet, pwiz::analysis::SpectrumList_FilterPredicate_IdSet, and SelectedIndexPredicate.
Definition at line 77 of file SpectrumList_Filter.hpp.
|
pure virtual |
return a string describing how the predicate filters
Implemented in pwiz::analysis::SpectrumList_FilterPredicate_IndexSet, pwiz::analysis::SpectrumList_FilterPredicate_ScanNumberSet, pwiz::analysis::SpectrumList_FilterPredicate_IdSet, pwiz::analysis::SpectrumList_FilterPredicate_ScanEventSet, pwiz::analysis::SpectrumList_FilterPredicate_ScanTimeRange, pwiz::analysis::SpectrumList_FilterPredicate_MSLevelSet, pwiz::analysis::SpectrumList_FilterPredicate_ChargeStateSet, pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet, pwiz::analysis::SpectrumList_FilterPredicate_DefaultArrayLengthSet, pwiz::analysis::SpectrumList_FilterPredicate_ActivationType, pwiz::analysis::SpectrumList_FilterPredicate_AnalyzerType, pwiz::analysis::SpectrumList_FilterPredicate_Polarity, pwiz::analysis::SpectrumList_FilterPredicate_MzPresent, pwiz::analysis::SpectrumList_FilterPredicate_ThermoScanFilter, EvenPredicate, EvenMS2Predicate, SelectedIndexPredicate, and HasBinaryDataPredicate.