MzMLSqliteHandler.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Hannes Roest $
// $Authors: Hannes Roest
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/KERNEL/MSExperiment.h>
#include <OpenMS/METADATA/ExperimentalSettings.h>
 
#include <OpenMS/OPENSWATHALGO/DATAACCESS/SwathMap.h>
 
namespace OpenMS
{
  class ProgressLogger;
  class SqliteConnector;
 
  namespace Internal
  {
 
    class OPENMS_DLLAPI MzMLSqliteHandler
    {
 
public:
 
      MzMLSqliteHandler(const std::string& filename, const UInt64 run_id);
 
 
      void readExperiment(MSExperiment & exp, bool meta_only = false) const;
 
      UInt64 getRunID() const;
 
      void readSpectra(std::vector<MSSpectrum> & exp, const std::vector<int> & indices, bool meta_only = false) const;
 
      void readChromatograms(std::vector<MSChromatogram> & exp, const std::vector<int> & indices, bool meta_only = false) const;
 
      Size getNrSpectra() const;
 
      Size getNrChromatograms() const;
 
      void setConfig(bool write_full_meta, bool use_lossy_compression, double linear_abs_mass_acc, int sql_batch_size = 500) 
      {
        write_full_meta_ = write_full_meta;
        use_lossy_compression_ = use_lossy_compression;
        linear_abs_mass_acc_ = linear_abs_mass_acc; 
        sql_batch_size_ = sql_batch_size; 
      }
 
      void setRunId(const UInt64 run_id);
 
      std::vector<size_t> getSpectraIndicesbyRT(double RT, double deltaRT, const std::vector<int> & indices) const;
 
protected:
 
      // These helpers operate on an open SQLite connection. They take the SqliteConnector
      // (a SQLite-type-free type) rather than a raw sqlite3*, so this installed header names
      // no SQLite type; the native handle is resolved in the .cpp via SqliteConnector_impl.h.
      void populateChromatogramsWithData_(SqliteConnector& conn, std::vector<MSChromatogram>& chromatograms) const;
 
      void populateChromatogramsWithData_(SqliteConnector& conn, std::vector<MSChromatogram>& chromatograms, const std::vector<int> & indices) const;
 
      void populateSpectraWithData_(SqliteConnector& conn, std::vector<MSSpectrum>& spectra) const;
 
      void populateSpectraWithData_(SqliteConnector& conn, std::vector<MSSpectrum>& spectra, const std::vector<int> & indices) const;
 
      void prepareChroms_(SqliteConnector& conn, std::vector<MSChromatogram>& chromatograms, const std::vector<int> & indices = {}) const;
 
      void prepareSpectra_(SqliteConnector& conn, std::vector<MSSpectrum>& spectra, const std::vector<int> & indices = {}) const;
 
public:
 
 
      void writeExperiment(const MSExperiment & exp);
 
      void createTables();
 
      void writeSpectra(const std::vector<MSSpectrum>& spectra);
 
      void writeChromatograms(const std::vector<MSChromatogram>& chroms);
 
      void writeRunLevelInformation(const MSExperiment& exp, bool write_full_meta);
 
protected:
 
      void createIndices_();
 
      std::string filename_;
 
      /*
       * These are spectra and chromatogram ids that are global for a specific
       * database file. Keeping track of them allows us to append spectra and
       * chromatograms multiple times to a database.
       *
       * However, currently they are initialized to zero when opening a new
       * file, so appending to an existing file won't work.
      */
      Int spec_id_;
      Int chrom_id_;
      UInt64 run_id_;
 
      bool use_lossy_compression_;
      double linear_abs_mass_acc_; 
      double write_full_meta_; 
      int sql_batch_size_; 
    };
 
 
  } // namespace Internal
} // namespace OpenMS