SpectrumRangeManager.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: Timo Sachsenberg $
// $Authors: Administrator $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/KERNEL/RangeManager.h>
#include <OpenMS/KERNEL/MSSpectrum.h>
#include <map>
#include <set>
 
namespace OpenMS
{
  class MSSpectrum;  // Forward declaration for MSSpectrum
  class OPENMS_DLLAPI SpectrumRangeManager : public RangeManager<RangeMZ, RangeIntensity, RangeMobility, RangeRT>
  {
  public:
    using BaseType = RangeManager<RangeMZ, RangeIntensity, RangeMobility, RangeRT>;
    
    SpectrumRangeManager() = default;
    
    SpectrumRangeManager(const SpectrumRangeManager& source) = default;
    
    SpectrumRangeManager(SpectrumRangeManager&& source) = default;
    
    SpectrumRangeManager& operator=(const SpectrumRangeManager& source) = default;
    
    SpectrumRangeManager& operator=(SpectrumRangeManager&& source) = default;
    
    ~SpectrumRangeManager() = default;
    
    void clearRanges()
    {
      BaseType::clearRanges();
      ms_level_ranges_.clear();
    }
    
    void extend(const BaseType& other, UInt ms_level = 0)
    {
      ms_level == 0 ? BaseType::extend(other) : ms_level_ranges_[ms_level].extend(other);
    }
    
    const BaseType& byMSLevel(UInt ms_level = 0) const
    {
      if (auto it = ms_level_ranges_.find(ms_level); it != ms_level_ranges_.end())
      {
        return it->second;
      }
      throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, "No ranges for this MS level", String(ms_level));
    }
 
    std::set<UInt> getMSLevels() const
    {
      std::set<UInt> ms_levels;
      for (const auto& [level, _] : ms_level_ranges_)
      {
        ms_levels.insert(level);
      }
      return ms_levels;
    }
 
    void extendRT(double rt, UInt ms_level = 0)
    {
      ms_level == 0 ? BaseType::extendRT(rt) : ms_level_ranges_[ms_level].extendRT(rt);
    }
 
    void extendMZ(double mz, UInt ms_level = 0)
    {
      ms_level == 0 ? BaseType::extendMZ(mz) : ms_level_ranges_[ms_level].extendMZ(mz);
    }
 
    void extendUnsafe(const MSSpectrum& spectrum, UInt ms_level = 0)
    {
      ms_level == 0 ? BaseType::extendUnsafe(spectrum.getRange()) : ms_level_ranges_[ms_level].extendUnsafe(spectrum.getRange());
   }
    
  protected:
    std::map<UInt, BaseType> ms_level_ranges_;
  };
 
} // namespace OpenMS