ParabolicFit.h

Go to the documentation of this file.

/**
 * \file IMP/algebra/ParabolicFit.h
 * \brief Fit data with parabola
 *
 * Copyright 2007-2022 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPALGEBRA_PARABOLIC_FIT_H
#define IMPALGEBRA_PARABOLIC_FIT_H

#include "Vector2D.h"
#include "GeometricPrimitiveD.h"
#include <cereal/access.hpp>
#include <vector>

IMPALGEBRA_BEGIN_NAMESPACE

//! Calculate parabola that fits best the input data points
class IMPALGEBRAEXPORT ParabolicFit2D : public GeometricPrimitiveD<2> {
 public:
  ParabolicFit2D() {}

  //! Constructor
  /**
     \param[in] data vector of pairs (VectorD<2>) with x and their
     corresponding y values
   */
  ParabolicFit2D(const Vector2Ds& data);

  //! fit error
  double get_fit_error() const { return error_; }

  //! get a value (a*x^2)
  double get_a() const { return a_; }

  //! get b value (b*x)
  double get_b() const { return b_; }

  //! get c value (constant)
  double get_c() const { return c_; }

  IMP_SHOWABLE_INLINE(ParabolicFit2D, {
    out << "y = " << a_ << "x^2 + " << b_ << "x + " << c_ << std::endl;
    out << "Error = " << error_ << std::endl;
  });

 private:
  void find_regression(const Vector2Ds& data);
  void evaluate_error(const Vector2Ds& data);

 private:
  double a_, b_, c_;
  double error_;

  friend class cereal::access;

  template<class Archive> void serialize(Archive &ar) {
    ar(a_, b_, c_, error_);
  }
};

IMP_VALUES(ParabolicFit2D, ParabolicFit2Ds);
#ifndef IMP_DOXYGEN
typedef ParabolicFit2D ParabolicFit;
#endif

IMPALGEBRA_END_NAMESPACE

#endif /* IMPALGEBRA_PARABOLIC_FIT_H */