vpFeatureMoment.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.
 *
 * Description:
 * Base for all moment features
 */

#ifndef _vpFeatureMoment_h_
#define _vpFeatureMoment_h_
 
#include <vector>
#include <string>
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpException.h>
#include <visp3/visual_features/vpBasicFeature.h>
 
BEGIN_VISP_NAMESPACE
class vpMomentObject;
class vpMomentDatabase;
class vpFeatureMomentDatabase;
class vpMoment;

class VISP_EXPORT vpFeatureMoment : public vpBasicFeature
{
protected:
  const vpMoment *moment;
  const vpMoment &getMoment() const { return *moment; }
  vpMomentDatabase &moments;
  vpFeatureMomentDatabase *featureMomentsDataBase;
  std::vector<vpMatrix> interaction_matrices;
 
  double A;
  double B;
  double C;
  std::string m_name;
 
  // private:
  //#ifndef DOXYGEN_SHOULD_SKIP_THIS
  //  vpFeatureMoment(const vpFeatureMoment &fm)
  //    : vpBasicFeature(), moment(nullptr), moments(fm.moments),
  //    featureMomentsDataBase(nullptr),
  //      interaction_matrices(), A(0), B(0), C(0)
  //  {
  //    throw vpException(vpException::functionNotImplementedError, "Not
  //    implemented!");
  //  }
  //  vpFeatureMoment &operator=(const vpFeatureMoment &){
  //    throw vpException(vpException::functionNotImplementedError, "Not
  //    implemented!"); return *this;
  //  }
  //#endif
#if !defined(VISP_MOMENTS_COMBINE_MATRICES)
#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
  vpFeatureMoment(const vpFeatureMoment &) = delete; // non construction-copyable
  vpFeatureMoment &operator=(const vpFeatureMoment &) = delete; // non copyable
#endif
#endif
 
public:
  vpFeatureMoment(vpMomentDatabase &data_base, double A_ = 0.0, double B_ = 0.0, double C_ = 0.0,
                  vpFeatureMomentDatabase *featureMoments = nullptr, unsigned int nbmatrices = 1)
    : vpBasicFeature(), moment(nullptr), moments(data_base), featureMomentsDataBase(featureMoments),
    interaction_matrices(nbmatrices), A(A_), B(B_), C(C_), m_name()
  { }

  virtual void compute_interaction(void);
 
  vpBasicFeature *duplicate() const VP_OVERRIDE;
  void display(const vpCameraParameters &cam, const vpImage<unsigned char> &I, const vpColor &color = vpColor::green,
               unsigned int thickness = 1) const VP_OVERRIDE;
  void display(const vpCameraParameters &cam, const vpImage<vpRGBa> &I, const vpColor &color = vpColor::green,
               unsigned int thickness = 1) const VP_OVERRIDE;
 
  int getDimension(unsigned int select = FEATURE_ALL) const;
  void init(void) VP_OVERRIDE;
  vpMatrix interaction(unsigned int select = FEATURE_ALL) VP_OVERRIDE;
 
  void linkTo(vpFeatureMomentDatabase &featureMoments);

  virtual const std::string momentName() const = 0;

  virtual const std::string name() const = 0;
 
  void print(unsigned int select = FEATURE_ALL) const VP_OVERRIDE;
  virtual void printDependencies(std::ostream &os) const;
 
  void update(double A, double B, double C);

  friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpFeatureMoment &featM);
};

class VISP_EXPORT vpMomentGenericFeature : public vpFeatureMoment
{
public:
  vpMomentGenericFeature(vpMomentDatabase &data_base, double A_, double B_, double C_,
                         vpFeatureMomentDatabase *featureMoments, const vpMoment *p_moment)
    : vpFeatureMoment(data_base, A_, B_, C_, featureMoments)
  {
    this->moment = p_moment;
  }

  const std::string momentName() const { return std::string(); }

  virtual const std::string name() const { return std::string(); }
};
END_VISP_NAMESPACE
#endif