Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Protected Attributes | List of all members
SpectrumAccessTransforming Class Referenceabstract

An abstract base class implementing a transforming wrapper around spectrum access. More...

#include <OpenMS/ANALYSIS/OPENSWATH/DATAACCESS/SpectrumAccessTransforming.h>

Inheritance diagram for SpectrumAccessTransforming:
ISpectrumAccess SpectrumAccessQuadMZTransforming

Public Member Functions

 SpectrumAccessTransforming (OpenSwath::SpectrumAccessPtr sptr)
 
virtual ~SpectrumAccessTransforming ()=0
 
virtual boost::shared_ptr< ISpectrumAccess > lightClone () const =0
 Light clone operator to produce a copy for concurrent read access. More...
 
virtual OpenSwath::SpectrumPtr getSpectrumById (int id)
 Return a pointer to a spectrum at the given id. More...
 
virtual OpenSwath::SpectrumMeta getSpectrumMetaById (int id) const
 Returns the meta information for a spectrum. More...
 
virtual std::vector< std::size_t > getSpectraByRT (double RT, double deltaRT) const
 Return a vector of ids of spectra that are within RT +/- deltaRT. More...
 
virtual size_t getNrSpectra () const
 Returns the number of spectra available. More...
 
virtual OpenSwath::ChromatogramPtr getChromatogramById (int id)
 Return a pointer to a chromatogram at the given id. More...
 
virtual size_t getNrChromatograms () const
 Returns the number of chromatograms available. More...
 
virtual std::string getChromatogramNativeID (int id) const
 Returns the native id of the chromatogram at the given id. More...
 
- Public Member Functions inherited from ISpectrumAccess
virtual ~ISpectrumAccess ()
 Destructor. More...
 

Protected Attributes

OpenSwath::SpectrumAccessPtr sptr_
 

Detailed Description

An abstract base class implementing a transforming wrapper around spectrum access.

Constructor & Destructor Documentation

◆ SpectrumAccessTransforming()

◆ ~SpectrumAccessTransforming()

virtual ~SpectrumAccessTransforming ( )
pure virtual

Member Function Documentation

◆ getChromatogramById()

virtual OpenSwath::ChromatogramPtr getChromatogramById ( int  id)
virtual

Return a pointer to a chromatogram at the given id.

Implements ISpectrumAccess.

◆ getChromatogramNativeID()

virtual std::string getChromatogramNativeID ( int  id) const
virtual

Returns the native id of the chromatogram at the given id.

Implements ISpectrumAccess.

◆ getNrChromatograms()

virtual size_t getNrChromatograms ( ) const
virtual

Returns the number of chromatograms available.

Implements ISpectrumAccess.

◆ getNrSpectra()

virtual size_t getNrSpectra ( ) const
virtual

Returns the number of spectra available.

Implements ISpectrumAccess.

◆ getSpectraByRT()

virtual std::vector<std::size_t> getSpectraByRT ( double  RT,
double  deltaRT 
) const
virtual

Return a vector of ids of spectra that are within RT +/- deltaRT.

Implements ISpectrumAccess.

◆ getSpectrumById()

virtual OpenSwath::SpectrumPtr getSpectrumById ( int  id)
virtual

Return a pointer to a spectrum at the given id.

Implements ISpectrumAccess.

Reimplemented in SpectrumAccessQuadMZTransforming.

◆ getSpectrumMetaById()

virtual OpenSwath::SpectrumMeta getSpectrumMetaById ( int  id) const
virtual

Returns the meta information for a spectrum.

Implements ISpectrumAccess.

◆ lightClone()

virtual boost::shared_ptr<ISpectrumAccess> lightClone ( ) const
pure virtual

Light clone operator to produce a copy for concurrent read access.

This function guarantees to produce a copy of the underlying object that provides thread-safe concurrent read access to the underlying data. It should be implemented with minimal copy-overhead to make this operation as fast as possible.

To use this function, each thread should call this function to produce an individual copy on which it can operate.

Implements ISpectrumAccess.

Implemented in SpectrumAccessQuadMZTransforming.

Member Data Documentation

◆ sptr_


OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:13 using doxygen 1.8.13