vpTutoMeanSquareFitting.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2025 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 */
 
#ifndef VP_TUTO_MEAN_SQUARE_FITTING_H
#define VP_TUTO_MEAN_SQUARE_FITTING_H
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpDisplay.h>
#include <visp3/core/vpImagePoint.h>
#include <visp3/core/vpMatrix.h>
#include <visp3/core/vpRobust.h>
 
#include "vpTutoParabolaModel.h"
 
#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace tutorial
{
class vpTutoMeanSquareFitting
{
public:
  vpTutoMeanSquareFitting(const unsigned int &degree, const unsigned int &height, const unsigned int &width);

  void fit(const std::vector<VISP_NAMESPACE_ADDRESSING vpImagePoint> &pts);

  double evaluate(const std::vector<VISP_NAMESPACE_ADDRESSING vpImagePoint> &pts);

  double evaluate(const VISP_NAMESPACE_ADDRESSING vpImagePoint &pt);

  double model(const double &u);
 
#ifdef VISP_HAVE_DISPLAY
  template<typename T>
  void display(const VISP_NAMESPACE_ADDRESSING vpImage<T> &I, const VISP_NAMESPACE_ADDRESSING vpColor &color,
               const unsigned int &vertPosLegend, const unsigned int &horPosLegend)
  {
    unsigned int width = I.getWidth();
    for (unsigned int u = 0; u < width; ++u) {
      int v = static_cast<int>(model(u));
      VISP_NAMESPACE_ADDRESSING vpDisplay::displayPoint(I, v, u, color, 1);
      VISP_NAMESPACE_ADDRESSING vpDisplay::displayText(I, vertPosLegend, horPosLegend, "Least-mean square model", color);
    }
  }
#endif

  inline void reinit()
  {
    m_isFitted = false;
  }
 
  inline vpTutoMeanSquareFitting &operator=(const vpTutoMeanSquareFitting &other)
  {
    m_model = other.m_model;
    m_isFitted = other.m_isFitted;
    return *this;
  }

  inline VISP_NAMESPACE_ADDRESSING vpColVector getCoeffs() const
  {
    return m_model.toVpColVector();
  }

  inline const vpTutoParabolaModel &getModel() const
  {
    return m_model;
  }
 
protected:
  unsigned int m_degree; 
  unsigned int m_height; 
  unsigned int m_width; 
  vpTutoParabolaModel m_model; 
  bool m_isFitted; 
};
}
#endif
#endif
#endif