DIAScoring.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, Witold Wolski $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CHEMISTRY/AASequence.h>
#include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
 
#include <OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h>
#include <OpenMS/OPENSWATHALGO/DATAACCESS/DataStructures.h>
#include <OpenMS/OPENSWATHALGO/DATAACCESS/ITransition.h>
#include <OpenMS/OPENSWATHALGO/DATAACCESS/TransitionExperiment.h>
 
#include <OpenMS/KERNEL/RangeManager.h>
 
namespace OpenMS
{
  class TheoreticalSpectrumGenerator;
 
  class OPENMS_DLLAPI DIAScoring :
    public DefaultParamHandler
  {
 
 
    typedef OpenSwath::SpectrumPtr SpectrumPtrType;
    typedef OpenSwath::LightTransition TransitionType;
 
public:
 
 
 
    DIAScoring();
 
    ~DIAScoring() override;
 
    // DIA / SWATH scoring
 
 
 
    void dia_isotope_scores(const std::vector<TransitionType>& transitions,
                            SpectrumSequence& spectrum,
                            OpenSwath::IMRMFeature* mrmfeature,
                            const RangeMobility& im_range,
                            double& isotope_corr,
                            double& isotope_overlap) const;
 
    void dia_massdiff_score(const std::vector<TransitionType>& transitions,
                            const SpectrumSequence& spectrum,
                            const std::vector<double>& normalized_library_intensity,
                            const RangeMobility& im_range,
                            double& ppm_score,
                            double& ppm_score_weighted,
                            std::vector<double>& diff_ppm) const;
 
    bool dia_ms1_massdiff_score(double precursor_mz, const SpectrumSequence& spectrum, const RangeMobility& im_range,
                                double& ppm_score) const;
 
    void dia_ms1_isotope_scores_averagine(double precursor_mz, const SpectrumSequence& spectrum, int charge_state, RangeMobility& im_range,
                                          double& isotope_corr, double& isotope_overlap) const;
    void dia_ms1_isotope_scores(double precursor_mz, const std::vector<SpectrumPtrType>& spectrum, RangeMobility& im_range,
                                double& isotope_corr, double& isotope_overlap, const EmpiricalFormula& sum_formula) const;
 
    void dia_by_ion_score(const SpectrumSequence& spectrum, AASequence& sequence,
                          int charge, const RangeMobility& im_range, double& bseries_score, double& yseries_score) const;
 
    void score_with_isotopes(SpectrumSequence& spectrum,
                             const std::vector<TransitionType>& transitions,
                             const RangeMobility& im_range,
                             double& dotprod,
                             double& manhattan) const;
 
    double getDIAExtractionWindow() const
    {
      return dia_extract_window_;
    }
 
    bool isDIAExtractionPPM() const
    {
      return dia_extraction_ppm_;
    }
 
private:
 
    DIAScoring(const DIAScoring& rhs);
 
    DIAScoring& operator=(const DIAScoring& rhs);
 
    void updateMembers_() override;
 
    void diaIsotopeScoresSub_(const std::vector<TransitionType>& transitions,
                              const SpectrumSequence& spectrum,
                              OpenSwath::IMRMFeature* mrmfeature,
                              const RangeMobility& im_range,
                              double& isotope_corr,
                              double& isotope_overlap) const;
 
private:
 
    void largePeaksBeforeFirstIsotope_(const SpectrumSequence& spectrum, double mono_mz, double mono_int, int& nr_occurrences, double& max_ratio, const RangeMobility& im_range) const;
 
    double scoreIsotopePattern_(const std::vector<double>& isotopes_int,
                                double product_mz,
                                int putative_fragment_charge) const;
 
    double scoreIsotopePattern_(const std::vector<double>& isotopes_int,
                                const EmpiricalFormula& sum_formula) const;
 
    double scoreIsotopePattern_(const std::vector<double>& isotopes_int,
                                const IsotopeDistribution& isotope_dist) const;
 
    void getIsotopeIntysFromExpSpec_(double precursor_mz, const SpectrumSequence& spectrum, int charge_state, const RangeMobility& im_range,
                                     std::vector<double>& isotopes_int) const;
 
    // Parameters
    double dia_extract_window_;
    double dia_byseries_intensity_min_;
    double dia_byseries_ppm_diff_;
    double dia_nr_isotopes_;
    double dia_nr_charges_;
    double peak_before_mono_max_ppm_diff_;
    bool dia_extraction_ppm_;
    bool dia_centroided_;
 
    TheoreticalSpectrumGenerator * generator;
  };
}