vpMomentAreaNormalized.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:
 * 2D normalized surface moment descriptor (usually described as An)
 */
#ifndef VP_MOMENT_AREA_NORMALIZED_H
#define VP_MOMENT_AREA_NORMALIZED_H
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpMoment.h>
 
BEGIN_VISP_NAMESPACE
class vpMomentObject;
class vpMomentCentered;

class VISP_EXPORT vpMomentAreaNormalized : public vpMoment
{
private:
  double desiredSurface;
  double desiredDepth;
 
public:
  vpMomentAreaNormalized(double a_star, double Z_star);
  void compute() VP_OVERRIDE;

  double getDesiredArea() const { return desiredSurface; }

  double getDesiredDepth() const { return desiredDepth; }

  void setDesiredDepth(double Z_star) { desiredDepth = Z_star; }

  void setDesiredArea(double a_star) { desiredSurface = a_star; }
 
#if defined(VISP_BUILD_DEPRECATED_FUNCTIONS)

  VP_DEPRECATED double getDesiredSurface() const { return desiredSurface; }
#endif

  const std::string name() const VP_OVERRIDE { return "vpMomentAreaNormalized"; }
  friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpMomentAreaNormalized &v);
  void printDependencies(std::ostream &os) const VP_OVERRIDE;
};
END_VISP_NAMESPACE
#endif