NLargest.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: Mathias Walzer $
// $Authors: $
// --------------------------------------------------------------------------
//
#pragma once
 
#include <OpenMS/KERNEL/StandardTypes.h>
#include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
#include <OpenMS/KERNEL/StandardTypes.h>
 
#include <OpenMS/KERNEL/MSSpectrum.h>
#include <OpenMS/KERNEL/MSExperiment.h>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI NLargest :
    public DefaultParamHandler
  {
public:
 
    // @name Constructors and Destructors
    // @{
 
    NLargest();
    NLargest(UInt n);
    ~NLargest() override;
 
    NLargest(const NLargest & source);
    NLargest & operator=(const NLargest & source);
 
    // @}
 
    template <typename SpectrumType>
    void filterSpectrum(SpectrumType & spectrum)
    {
      if (spectrum.size() <= peakcount_) return;
 
      // sort by reverse intensity
      spectrum.sortByIntensity(true);
 
      // keep the n largest peaks if more than n are present
      std::vector<Size> indices;
      for (Size i = 0; i != peakcount_; ++i)
      {
        indices.push_back(i);
      }
      spectrum.select(indices);
    }
 
    void filterPeakSpectrum(PeakSpectrum & spectrum);
 
    void filterPeakMap(PeakMap & exp);
 
    //TODO reimplement DefaultParamHandler::updateMembers_()
 
    // @}
 
protected:
    void updateMembers_() override;
    UInt peakcount_;
 
    void init_();
 
  };
 
}