SpectraSTSimilarityScore.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: Timo Sachsenberg $
// $Authors: David Wojnar $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/COMPARISON/SPECTRA/PeakSpectrumCompareFunctor.h>
#include <OpenMS/COMPARISON/SPECTRA/BinnedSpectrum.h>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI SpectraSTSimilarityScore :
    public PeakSpectrumCompareFunctor
  {
public:
 
    // @name Constructors and Destructors
    // @{
    SpectraSTSimilarityScore();
 
    SpectraSTSimilarityScore(const SpectraSTSimilarityScore & source);
 
    ~SpectraSTSimilarityScore() override;
    // @}
 
    SpectraSTSimilarityScore & operator=(const SpectraSTSimilarityScore & source);
 
    double operator()(const PeakSpectrum & spec1, const PeakSpectrum & spec2) const override;
    double operator()(const BinnedSpectrum & bin1, const BinnedSpectrum & bin2)   const;
    double operator()(const PeakSpectrum & spec) const override;
 
    bool preprocess(PeakSpectrum & spec, float remove_peak_intensity_threshold = 2.01, UInt cut_peaks_below = 1000, Size min_peak_number = 5, Size max_peak_number = 150);
 
 
    BinnedSpectrum transform(const PeakSpectrum & spec);
 
    double dot_bias(const BinnedSpectrum & bin1, const BinnedSpectrum & bin2, double dot_product = -1) const;
 
    double delta_D(double top_hit, double runner_up);
 
    double compute_F(double dot_product, double delta_D, double dot_bias);
 
 
 
    static PeakSpectrumCompareFunctor * create() { return new SpectraSTSimilarityScore(); }
 
    static const String getProductName()
    {
      return "SpectraSTSimilarityScore";
    }
 
protected:
 
 
  };
 
}