| OpenMS 2.5.0

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:

## Public Member Functions

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

explicit

## ◆ ~SpectrumAccessTransforming()

~SpectrumAccessTransforming | ( |  | ) |

override pure virtual

## Member Function Documentation

## ◆ getChromatogramById()

OpenSwath::ChromatogramPtr getChromatogramById | ( | int | id | ) |

override virtual

Return a pointer to a chromatogram at the given id.

Implements ISpectrumAccess.

## ◆ getChromatogramNativeID()

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

override virtual

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

Implements ISpectrumAccess.

## ◆ getNrChromatograms()

size_t getNrChromatograms | ( |  | ) | const

override virtual

Returns the number of chromatograms available.

Implements ISpectrumAccess.

## ◆ getNrSpectra()

size_t getNrSpectra | ( |  | ) | const

override virtual

Returns the number of spectra available.

Implements ISpectrumAccess.

## ◆ getSpectraByRT()

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

override virtual

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

Implements ISpectrumAccess.

## ◆ getSpectrumById()

OpenSwath::SpectrumPtr getSpectrumById | ( | int | id | ) |

override virtual

Return a pointer to a spectrum at the given id.

Implements ISpectrumAccess.

## ◆ getSpectrumMetaById()

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

override virtual

Returns the meta information for a spectrum.

Implements ISpectrumAccess.

## ◆ lightClone()

boost::shared_ptr<ISpectrumAccess> lightClone | ( |  | ) | const

override 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_

OpenSwath::SpectrumAccessPtr sptr_

protected