SwathQC.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/OPENSWATHALGO/DATAACCESS/SwathMap.h>
#include <OpenMS/OpenMSConfig.h>
 
#include <functional>
#include <map>
#include <vector>
 
namespace OpenMS
{
  class String;
  class MSSpectrum;
  class ExperimentalSettings;
 
}
 
namespace OpenSwath
{
 
  class OPENMS_DLLAPI SwathQC
  {
  public:
    typedef std::map<int,int> ChargeDistribution;
    
    SwathQC() = delete;
 
    SwathQC(const size_t cd_spectra, const double decon_ms1_mz_tol);
 
 
    std::function<void(const OpenMS::ExperimentalSettings& es)> getExpSettingsFunc();
 
    std::function<void (const OpenMS::MSSpectrum&)> getSpectraProcessingFunc();
 
 
    static ChargeDistribution getChargeDistribution(const std::vector<SwathMap>& swath_maps, const size_t nr_samples, const double mz_tol);
 
 
    void storeJSON(const OpenMS::String& filename);
 
    const ChargeDistribution& getChargeDistribution() const;
 
    void setNrMS1Spectra(size_t nr);
 
 
   protected: 
 
    static bool isSubsampledSpectrum_(const size_t total_spec_count, const size_t subsample_count, const size_t idx);
   
   private: 
 
    ChargeDistribution cd_;
 
    size_t nr_ms1_spectra_;
    size_t cd_spectra_;
    double decon_ms1_mz_tol_;
 
    size_t ms1_spectra_seen_;
  };
    
}