Provides a custom-sorted spectrum list. More...
#include <SpectrumList_Sorter.hpp>
Inheritance diagram for pwiz::analysis::SpectrumList_Sorter:
Classes | |
| struct | Predicate |
| client-implemented sort predicate – called during construction of SpectrumList_Sorter to sort the underlying spectrum list More... | |
Public Member Functions | |
| SpectrumList_Sorter (const msdata::SpectrumListPtr &inner, const Predicate &predicate, bool stable=false) | |
SpectrumList interface | |
| virtual size_t | size () const |
| returns the number of spectra | |
| virtual const msdata::SpectrumIdentity & | spectrumIdentity (size_t index) const |
| access to a spectrum index | |
| virtual msdata::SpectrumPtr | spectrum (size_t index, bool getBinaryData=false) const |
| retrieve a spectrum by index | |
 Public Member Functions inherited from pwiz::msdata::SpectrumListWrapper | |
| SpectrumListWrapper (const SpectrumListPtr &inner) | |
| virtual bool | empty () const |
| returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL) | |
| virtual SpectrumPtr | spectrum (size_t index, DetailLevel detailLevel) const |
| retrieve a spectrum by index | |
| virtual const boost::shared_ptr< const DataProcessing > | dataProcessingPtr () const |
| returns the data processing affecting spectra retrieved through this interface | |
| Public Member Functions inherited from pwiz::msdata::SpectrumList | |
| virtual size_t | find (const std::string &id) const |
| find id in the spectrum index (returns size() on failure) | |
| virtual IndexList | findNameValue (const std::string &name, const std::string &value) const |
| find all spectrum indexes with specified name/value pair | |
| virtual IndexList | findSpotID (const std::string &spotID) const |
| find all spectrum indexes with spotID (returns empty vector on failure) | |
| virtual SpectrumPtr | spectrum (const SpectrumPtr &seed, bool getBinaryData) const |
| get a copy of the seed spectrum, optionally with its binary data populated this is useful for formats like mzML that can delay loading of binary data | |
| virtual | ~SpectrumList () |
Private Member Functions | |
| SpectrumList_Sorter (SpectrumList_Sorter &) | |
| SpectrumList_Sorter & | operator= (SpectrumList_Sorter &) |
Private Attributes | |
| boost::shared_ptr< Impl > | impl_ |
Additional Inherited Members | |
| Protected Attributes inherited from pwiz::msdata::SpectrumListWrapper | |
| SpectrumListPtr | inner_ |
| DataProcessingPtr | dp_ |
Detailed Description
Provides a custom-sorted spectrum list.
Definition at line 39 of file SpectrumList_Sorter.hpp.
Constructor & Destructor Documentation
| pwiz::analysis::SpectrumList_Sorter::SpectrumList_Sorter | ( | const msdata::SpectrumListPtr & | inner, |
| const Predicate & | predicate, | ||
| bool | stable = false |
||
| ) |
|
private |
Member Function Documentation
|
virtual |
returns the number of spectra
Reimplemented from pwiz::msdata::SpectrumListWrapper.
|
virtual |
access to a spectrum index
Reimplemented from pwiz::msdata::SpectrumListWrapper.
|
virtual |
retrieve a spectrum by index
- binary data arrays will be provided if (getBinaryData == true);
- client may assume the underlying Spectrum* is valid
Implements pwiz::msdata::SpectrumListWrapper.
|
private |
Member Data Documentation
|
private |
Definition at line 78 of file SpectrumList_Sorter.hpp.
The documentation for this class was generated from the following file:
- /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/analysis/spectrum_processing/SpectrumList_Sorter.hpp
