SplineInterpolatedPeaks.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2022.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Lars Nilse $
// $Authors: Lars Nilse $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/KERNEL/StandardTypes.h>
#include <OpenMS/DATASTRUCTURES/DRange.h>
#include <OpenMS/FILTERING/DATAREDUCTION/SplinePackage.h>

#include <vector>

namespace OpenMS
{
class OPENMS_DLLAPI SplineInterpolatedPeaks
{
  public:
    SplineInterpolatedPeaks(const std::vector<double>& pos, const std::vector<double>& intensity);

    SplineInterpolatedPeaks(const MSSpectrum& raw_spectrum);

    SplineInterpolatedPeaks(const MSChromatogram& raw_chromatogram);

    ~SplineInterpolatedPeaks();

    double getPosMin() const;

    double getPosMax() const;

    size_t size() const;

    class OPENMS_DLLAPI Navigator
    {
      public:
        Navigator(const std::vector<SplinePackage> * packages, double posMax, double scaling);

        Navigator();

        ~Navigator();

        double eval(double pos);

        double getNextPos(double pos);

      private:
        
        const std::vector<SplinePackage> * packages_;

        size_t last_package_;

        double pos_max_;
        
        double pos_step_width_scaling_;
    };

    SplineInterpolatedPeaks::Navigator getNavigator(double scaling = 0.7);

  private:

    SplineInterpolatedPeaks();
    
    double pos_min_;
    double pos_max_;

    std::vector<SplinePackage> packages_;

    void init_(const std::vector<double>& pos, const std::vector<double>& intensity);


};

}