vpMoment.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2023 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 2D moment descriptor
 */
 
#ifndef _vpMoment_h_
#define _vpMoment_h_
 
#include <iostream>
#include <vector>
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpException.h>
 
BEGIN_VISP_NAMESPACE
class vpMomentDatabase;
class vpMomentObject;
 
class VISP_EXPORT vpMoment
{
private:
  vpMomentObject *object;
  vpMomentDatabase *moments;
  std::string m_name;
 
protected:
  std::vector<double> values;
  inline vpMomentDatabase &getMoments() const { return *moments; }
 
  // private:
  //#ifndef DOXYGEN_SHOULD_SKIP_THIS
  //  vpMoment(const vpMoment &)
  //    : object(nullptr), moments(nullptr), values()
  //  {
  //    throw vpException(vpException::functionNotImplementedError,"Not
  //    implemented!");
  //  }
  //  vpMoment &operator=(const vpMoment &){
  //    throw vpException(vpException::functionNotImplementedError,"Not
  //    implemented!"); return *this;
  //  }
  //#endif
 
public:
  vpMoment();
 
  virtual ~vpMoment() { }
 
  virtual void compute() = 0;
  inline const vpMomentObject &getObject() const { return *object; }
  const std::vector<double> &get() const { return values; }
  void linkTo(vpMomentDatabase &moments);
  virtual const std::string name() const = 0;
  virtual void printDependencies(std::ostream &os) const;
  void update(vpMomentObject &object);
  friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpMoment &m);
};
END_VISP_NAMESPACE
#endif