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

SpectrumList implementation that can create 3D spectra of ion mobility drift time and m/z. More...

#include <SpectrumList_3D.hpp>

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

Public Member Functions

 SpectrumList_3D (const msdata::SpectrumListPtr &inner)
 
virtual msdata::SpectrumPtr spectrum (size_t index, bool getBinaryData=false) const
 retrieve a spectrum by index More...
 
virtual Spectrum3DPtr spectrum3d (double scanStartTime, const boost::icl::interval_set< double > &driftTimeRanges) const
 creates a 3d spectrum at the given scan start time (specified in seconds) and including the given drift time ranges (specified in milliseconds) 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 ()
 

Static Public Member Functions

static bool accept (const msdata::SpectrumListPtr &inner)
 

Private Attributes

int mode_
 

Additional Inherited Members

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

Detailed Description

SpectrumList implementation that can create 3D spectra of ion mobility drift time and m/z.

Definition at line 39 of file SpectrumList_3D.hpp.

Constructor & Destructor Documentation

§ SpectrumList_3D()

pwiz::analysis::SpectrumList_3D::SpectrumList_3D ( const msdata::SpectrumListPtr inner)

Member Function Documentation

§ accept()

static bool pwiz::analysis::SpectrumList_3D::accept ( const msdata::SpectrumListPtr inner)
static

§ spectrum()

virtual msdata::SpectrumPtr pwiz::analysis::SpectrumList_3D::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.

§ spectrum3d()

virtual Spectrum3DPtr pwiz::analysis::SpectrumList_3D::spectrum3d ( double  scanStartTime,
const boost::icl::interval_set< double > &  driftTimeRanges 
) const
virtual

creates a 3d spectrum at the given scan start time (specified in seconds) and including the given drift time ranges (specified in milliseconds)

Member Data Documentation

§ mode_

int pwiz::analysis::SpectrumList_3D::mode_
private

Definition at line 52 of file SpectrumList_3D.hpp.


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