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

SpectrumList filter, for creating Spectrum sub-lists. More...

#include <SpectrumList_MZWindow.hpp>

Inheritance diagram for pwiz::analysis::SpectrumList_MZWindow:
pwiz::msdata::SpectrumListWrapper pwiz::msdata::SpectrumList

Public Member Functions

 SpectrumList_MZWindow (const msdata::SpectrumListPtr original, double mzLow, double mzHigh)
 
SpectrumList interface
virtual msdata::SpectrumPtr spectrum (size_t index, bool getBinaryData=false) const
 retrieve a spectrum by index More...
 
- Public Member Functions inherited from pwiz::msdata::SpectrumListWrapper
 SpectrumListWrapper (const SpectrumListPtr &inner)
 
virtual size_t size () const
 returns the number of spectra More...
 
virtual bool empty () const
 returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL) More...
 
virtual const SpectrumIdentityspectrumIdentity (size_t index) const
 access to a spectrum index More...
 
virtual SpectrumPtr spectrum (size_t index, DetailLevel detailLevel) const
 retrieve a spectrum by index More...
 
virtual const boost::shared_ptr< const DataProcessingdataProcessingPtr () const
 returns the data processing affecting spectra retrieved through this interface More...
 
SpectrumListPtr inner () const
 
SpectrumListPtr innermost () const
 
- 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) More...
 
virtual size_t findAbbreviated (const std::string &abbreviatedId, char delimiter='.') const
 find an abbreviated id (e.g. "1.1.123.2" for "sample=1 period=1 cycle=123 experiment=2") in the spectrum index (returns size() on failure) More...
 
virtual IndexList findNameValue (const std::string &name, const std::string &value) const
 find all spectrum indexes with specified name/value pair More...
 
virtual IndexList findSpotID (const std::string &spotID) const
 find all spectrum indexes with spotID (returns empty vector on failure) More...
 
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 More...
 
virtual void warn_once (const char *msg) const
 issues a warning once per SpectrumList instance (based on string hash) More...
 
virtual ~SpectrumList ()
 

Private Member Functions

 SpectrumList_MZWindow (SpectrumList_MZWindow &)
 
SpectrumList_MZWindowoperator= (SpectrumList_MZWindow &)
 

Private Attributes

double mzLow_
 
double mzHigh_
 

Additional Inherited Members

- Protected Attributes inherited from pwiz::msdata::SpectrumListWrapper
SpectrumListPtr inner_
 
DataProcessingPtr dp_
 

Detailed Description

SpectrumList filter, for creating Spectrum sub-lists.

Definition at line 37 of file SpectrumList_MZWindow.hpp.

Constructor & Destructor Documentation

§ SpectrumList_MZWindow() [1/2]

pwiz::analysis::SpectrumList_MZWindow::SpectrumList_MZWindow ( const msdata::SpectrumListPtr  original,
double  mzLow,
double  mzHigh 
)

§ SpectrumList_MZWindow() [2/2]

pwiz::analysis::SpectrumList_MZWindow::SpectrumList_MZWindow ( SpectrumList_MZWindow )
private

Member Function Documentation

§ spectrum()

virtual msdata::SpectrumPtr pwiz::analysis::SpectrumList_MZWindow::spectrum ( size_t  index,
bool  getBinaryData = false 
) const
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.

§ operator=()

SpectrumList_MZWindow& pwiz::analysis::SpectrumList_MZWindow::operator= ( SpectrumList_MZWindow )
private

Member Data Documentation

§ mzLow_

double pwiz::analysis::SpectrumList_MZWindow::mzLow_
private

Definition at line 49 of file SpectrumList_MZWindow.hpp.

§ mzHigh_

double pwiz::analysis::SpectrumList_MZWindow::mzHigh_
private

Definition at line 50 of file SpectrumList_MZWindow.hpp.


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