ProteoWizard
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
pwiz::analysis::SpectrumList_ZeroSamplesFilter Class Reference

SpectrumList implementation to return spectra with or without extra zero samples. More...

#include <SpectrumList_ZeroSamplesFilter.hpp>

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

List of all members.

Public Types

enum  Mode { Mode_RemoveExtraZeros, Mode_AddMissingZeros }

Public Member Functions

 SpectrumList_ZeroSamplesFilter (const msdata::SpectrumListPtr &inner, const util::IntegerSet &msLevelsToFilter, Mode mode, size_t FlankingZeroCount)
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 size_t size () const
 returns the number of spectra
virtual bool empty () const
 returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL)
virtual const SpectrumIdentityspectrumIdentity (size_t index) const
 access to a spectrum index
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 ()

Static Public Member Functions

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

Private Attributes

const Mode mode_
const size_t flankingZeroCount_
const util::IntegerSet msLevelsToFilter_

Additional Inherited Members

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

Detailed Description

SpectrumList implementation to return spectra with or without extra zero samples.

Definition at line 38 of file SpectrumList_ZeroSamplesFilter.hpp.


Member Enumeration Documentation

Enumerator:
Mode_RemoveExtraZeros 
Mode_AddMissingZeros 

Definition at line 42 of file SpectrumList_ZeroSamplesFilter.hpp.


Constructor & Destructor Documentation

pwiz::analysis::SpectrumList_ZeroSamplesFilter::SpectrumList_ZeroSamplesFilter ( const msdata::SpectrumListPtr inner,
const util::IntegerSet msLevelsToFilter,
Mode  mode,
size_t  FlankingZeroCount 
)

Member Function Documentation

static bool pwiz::analysis::SpectrumList_ZeroSamplesFilter::accept ( const msdata::SpectrumListPtr inner)
static
virtual msdata::SpectrumPtr pwiz::analysis::SpectrumList_ZeroSamplesFilter::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.


Member Data Documentation

const Mode pwiz::analysis::SpectrumList_ZeroSamplesFilter::mode_
private

Definition at line 55 of file SpectrumList_ZeroSamplesFilter.hpp.

const size_t pwiz::analysis::SpectrumList_ZeroSamplesFilter::flankingZeroCount_
private

Definition at line 56 of file SpectrumList_ZeroSamplesFilter.hpp.

const util::IntegerSet pwiz::analysis::SpectrumList_ZeroSamplesFilter::msLevelsToFilter_
private

Definition at line 57 of file SpectrumList_ZeroSamplesFilter.hpp.


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