OpenMS  2.8.0
Classes | Typedefs
OpenMS::Interfaces Namespace Reference

Classes

struct  BinaryDataArray
 The datastructures used by the OpenSwath interfaces. More...
 
struct  ChromatogramMeta
 Identifying information for a chromatogram. More...
 
struct  Chromatogram
 A single chromatogram. More...
 
struct  SpectrumMeta
 Identifying information for a spectrum. More...
 
struct  Spectrum
 The structure that captures the generation of a peak list (including the underlying acquisitions) More...
 
class  IMSDataConsumer
 The interface of a consumer of spectra and chromatograms. More...
 
class  ISpectraReader
 The interface of read-access to a list of spectra. More...
 
class  IChromatogramsReader
 The interface of read-access to a list of chromatograms. More...
 
class  ISpectraWriter
 
class  IChromatogramsWriter
 

Typedefs

typedef boost::shared_ptr< BinaryDataArrayBinaryDataArrayPtr
 
typedef boost::shared_ptr< ChromatogramMetaChromatogramMetaPtr
 
typedef boost::shared_ptr< ChromatogramChromatogramPtr
 
typedef boost::shared_ptr< SpectrumMetaSpectrumMetaPtr
 
typedef boost::shared_ptr< SpectrumSpectrumPtr
 
typedef IMSDataConsumer IMSDataConsumer
 
typedef boost::shared_ptr< ISpectraReaderSpectraReaderPtr
 
typedef boost::shared_ptr< IChromatogramsReaderChromatogramsReaderPtr
 
typedef boost::shared_ptr< ISpectraWriterSpectraWriterPtr
 
typedef boost::shared_ptr< IChromatogramsWriterChromatogramsWriterPtr
 

Class Documentation

◆ OpenMS::Interfaces::BinaryDataArray

struct OpenMS::Interfaces::BinaryDataArray

The datastructures used by the OpenSwath interfaces.

Many of them are closely related to Proteowizard data structures, originally written by Darren Kessner and released under the Apache 2.0 licence and can be found in the file pwiz/data/msdata/MSData.hpp.

Original author: Darren Kessner darre.nosp@m.n@pr.nosp@m.oteow.nosp@m.izar.nosp@m.d.org

Copyright 2007 Spielberg Family Center for Applied Proteomics Cedars-Sinai Medical Center, Los Angeles, California 90048

The following datastructures are used :

  • BinaryDataArray : a struct that holds a std::vector<double> with the data
  • ChromatogramMeta : meta information of a chromatogram (index)
  • Chromatogram : chromatogram data. Contains a vector of pointers to BinaryDataArray, the first one is time array (RT), the second one is intensity
  • SpectrumMeta : meta information of a spectrum (index, identifier, RT, ms_level)
  • Spectrum : spectrum data. Contains a vector of pointers to BinaryDataArray, the first one is mz array, the second one is intensity The structure into which encoded binary data goes.
Collaboration diagram for BinaryDataArray:
[legend]
Class Members
vector< double > data this optional attribute may reference the 'id' attribute of the appropriate dataProcessing.

the binary data.

Typedef Documentation

◆ BinaryDataArrayPtr

typedef boost::shared_ptr<BinaryDataArray> BinaryDataArrayPtr

◆ ChromatogramMetaPtr

typedef boost::shared_ptr<ChromatogramMeta> ChromatogramMetaPtr

◆ ChromatogramPtr

typedef boost::shared_ptr<Chromatogram> ChromatogramPtr

◆ ChromatogramsReaderPtr

typedef boost::shared_ptr<IChromatogramsReader> ChromatogramsReaderPtr

◆ ChromatogramsWriterPtr

typedef boost::shared_ptr<IChromatogramsWriter> ChromatogramsWriterPtr

◆ IMSDataConsumer

◆ SpectraReaderPtr

typedef boost::shared_ptr<ISpectraReader> SpectraReaderPtr

◆ SpectraWriterPtr

typedef boost::shared_ptr<ISpectraWriter> SpectraWriterPtr

◆ SpectrumMetaPtr

typedef boost::shared_ptr<SpectrumMeta> SpectrumMetaPtr

◆ SpectrumPtr

typedef boost::shared_ptr<Spectrum> SpectrumPtr