ProteoWizard
Public Member Functions | List of all members
pwiz::msdata::detail::SpectrumList_Bruker Class Reference

#include <SpectrumList_Bruker.hpp>

Inheritance diagram for pwiz::msdata::detail::SpectrumList_Bruker:
pwiz::msdata::SpectrumListIonMobilityBase pwiz::msdata::SpectrumListBase pwiz::msdata::SpectrumList

Public Member Functions

virtual size_t size () const
 returns the number of spectra
 
virtual const SpectrumIdentityspectrumIdentity (size_t index) const
 access to a spectrum index
 
virtual size_t find (const string &id) const
 find id in the spectrum index (returns size() on failure)
 
virtual SpectrumPtr spectrum (size_t index, bool getBinaryData) const
 retrieve a spectrum by index
 
virtual SpectrumPtr spectrum (size_t index, DetailLevel detailLevel) const
 retrieve a spectrum by index
 
virtual SpectrumPtr spectrum (size_t index, bool getBinaryData, const pwiz::util::IntegerSet &msLevelsToCentroid) const
 
virtual SpectrumPtr spectrum (size_t index, DetailLevel detailLevel, const pwiz::util::IntegerSet &msLevelsToCentroid) const
 
virtual bool hasIonMobility () const
 
virtual bool hasPASEF () const
 
virtual bool canConvertIonMobilityAndCCS () const
 
virtual double ionMobilityToCCS (double inverseK0, double mz, int charge) const
 
virtual double ccsToIonMobility (double ccs, double mz, int charge) const
 
- Public Member Functions inherited from pwiz::msdata::SpectrumListBase
 SpectrumListBase ()
 
virtual const boost::shared_ptr< const DataProcessingdataProcessingPtr () const
 implementation of SpectrumList
 
virtual void setDataProcessingPtr (DataProcessingPtr dp)
 set DataProcessing
 
virtual void warn_once (const char *msg) const
 issues a warning once per SpectrumList instance (based on string hash)
 
- Public Member Functions inherited from pwiz::msdata::SpectrumList
virtual bool empty () const
 returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL)
 
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)
 
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 ()
 

Additional Inherited Members

- Protected Attributes inherited from pwiz::msdata::SpectrumListBase
DataProcessingPtr dp_
 
const pwiz::util::IntegerSet MSLevelsNone
 

Detailed Description

Definition at line 47 of file SpectrumList_Bruker.hpp.

Member Function Documentation

◆ size()

virtual size_t pwiz::msdata::detail::SpectrumList_Bruker::size ( ) const
virtual

returns the number of spectra

Implements pwiz::msdata::SpectrumList.

◆ spectrumIdentity()

virtual const SpectrumIdentity & pwiz::msdata::detail::SpectrumList_Bruker::spectrumIdentity ( size_t  index) const
virtual

access to a spectrum index

Implements pwiz::msdata::SpectrumList.

◆ find()

virtual size_t pwiz::msdata::detail::SpectrumList_Bruker::find ( const string &  id) const
virtual

find id in the spectrum index (returns size() on failure)

Reimplemented from pwiz::msdata::SpectrumList.

◆ spectrum() [1/4]

virtual SpectrumPtr pwiz::msdata::detail::SpectrumList_Bruker::spectrum ( size_t  index,
bool  getBinaryData 
) 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::SpectrumList.

◆ spectrum() [2/4]

virtual SpectrumPtr pwiz::msdata::detail::SpectrumList_Bruker::spectrum ( size_t  index,
DetailLevel  detailLevel 
) const
virtual

retrieve a spectrum by index

  • detailLevel determines what fields are guaranteed present on the spectrum after the call
  • client may assume the underlying Spectrum* is valid

Reimplemented from pwiz::msdata::SpectrumList.

◆ spectrum() [3/4]

virtual SpectrumPtr pwiz::msdata::detail::SpectrumList_Bruker::spectrum ( size_t  index,
bool  getBinaryData,
const pwiz::util::IntegerSet msLevelsToCentroid 
) const
virtual

◆ spectrum() [4/4]

virtual SpectrumPtr pwiz::msdata::detail::SpectrumList_Bruker::spectrum ( size_t  index,
DetailLevel  detailLevel,
const pwiz::util::IntegerSet msLevelsToCentroid 
) const
virtual

◆ hasIonMobility()

virtual bool pwiz::msdata::detail::SpectrumList_Bruker::hasIonMobility ( ) const
virtual

◆ hasPASEF()

virtual bool pwiz::msdata::detail::SpectrumList_Bruker::hasPASEF ( ) const
virtual

◆ canConvertIonMobilityAndCCS()

virtual bool pwiz::msdata::detail::SpectrumList_Bruker::canConvertIonMobilityAndCCS ( ) const
virtual

◆ ionMobilityToCCS()

virtual double pwiz::msdata::detail::SpectrumList_Bruker::ionMobilityToCCS ( double  inverseK0,
double  mz,
int  charge 
) const
virtual

◆ ccsToIonMobility()

virtual double pwiz::msdata::detail::SpectrumList_Bruker::ccsToIonMobility ( double  ccs,
double  mz,
int  charge 
) const
virtual

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