InterpolationModel.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: $
// --------------------------------------------------------------------------
 
 
#pragma once
 
#include <OpenMS/FEATUREFINDER/BaseModel.h>
#include <OpenMS/ML/INTERPOLATION/LinearInterpolation.h>
 
namespace OpenMS
{
  class OPENMS_DLLAPI InterpolationModel :
    public BaseModel
  {
 
public:
    typedef double IntensityType;
    typedef DPosition<1> PositionType;
    typedef double CoordinateType;
    using KeyType = double;
    typedef Math::LinearInterpolation<KeyType> LinearInterpolation;
 
    InterpolationModel() :
      BaseModel(),
      interpolation_()
    {
      this->defaults_.setValue("interpolation_step", 0.1, "Sampling rate for the interpolation of the model function ");
      this->defaults_.setValue("intensity_scaling", 1.0, "Scaling factor used to adjust the model distribution to the intensities of the data");
      defaultsToParam_();
    }
 
    InterpolationModel(const InterpolationModel & source) :
      BaseModel(source),
      interpolation_(source.interpolation_),
      interpolation_step_(source.interpolation_step_),
      scaling_(source.scaling_)
    {
      updateMembers_();
    }
 
    ~InterpolationModel() override = default;
 
    InterpolationModel & operator=(const InterpolationModel & source)
    {
      if (&source == this) return *this;
 
      BaseModel::operator=(source);
      interpolation_step_ = source.interpolation_step_;
      interpolation_ = source.interpolation_;
      scaling_ = source.scaling_;
 
      updateMembers_();
 
      return *this;
    }
 
    IntensityType getIntensity(const PositionType & pos) const override
    {
      return interpolation_.value(pos[0]);
    }
 
    IntensityType getIntensity(CoordinateType coord) const
    {
      return interpolation_.value(coord);
    }
 
    const LinearInterpolation & getInterpolation() const
    {
      return interpolation_;
    }
 
    CoordinateType getScalingFactor() const
    {
      return scaling_;
    }
 
    virtual void setOffset(CoordinateType offset)
    {
      interpolation_.setOffset(offset);
    }
 
    void getSamples(SamplesType & cont) const override
    {
      cont.clear();
      using PeakT = BaseModel::PeakType;
      PeakT peak;
      for (Size i = 0; i < interpolation_.getData().size(); ++i)
      {
        peak.getPosition()[0] = interpolation_.index2key((KeyType)i);
        peak.setIntensity((PeakT::IntensityType)interpolation_.getData()[i]);
        cont.push_back(peak);
      }
    }
 
    virtual CoordinateType getCenter() const
    {
      throw Exception::NotImplemented(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION);
    }
 
    virtual void setSamples()
    {
      throw Exception::NotImplemented(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION);
    }
 
    void setInterpolationStep(CoordinateType interpolation_step)
    {
      interpolation_step_ = interpolation_step;
      this->param_.setValue("interpolation_step", interpolation_step_);
    }
 
    void setScalingFactor(CoordinateType scaling)
    {
      scaling_ = scaling;
      this->param_.setValue("intensity_scaling", scaling_);
    }
 
protected:
    LinearInterpolation interpolation_;
    CoordinateType interpolation_step_;
    CoordinateType scaling_;
 
    void updateMembers_() override
    {
      BaseModel::updateMembers_();
      interpolation_step_ = this->param_.getValue("interpolation_step");
      scaling_ = this->param_.getValue("intensity_scaling");
    }
 
  };
}