Visual Servoing Platform  version 3.6.1 under development (2024-07-18)
vpMomentAreaNormalized.h
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2023 by Inria. All rights reserved.
4  *
5  * This software is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  * See the file LICENSE.txt at the root directory of this source
10  * distribution for additional information about the GNU GPL.
11  *
12  * For using ViSP with software that can not be combined with the GNU
13  * GPL, please contact Inria about acquiring a ViSP Professional
14  * Edition License.
15  *
16  * See https://visp.inria.fr for more information.
17  *
18  * This software was developed at:
19  * Inria Rennes - Bretagne Atlantique
20  * Campus Universitaire de Beaulieu
21  * 35042 Rennes Cedex
22  * France
23  *
24  * If you have questions regarding the use of this file, please contact
25  * Inria at visp@inria.fr
26  *
27  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
28  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
29  *
30  * Description:
31  * 2D normalized surface moment descriptor (usually described as An)
32  */
37 #ifndef _vpMomentAreaNormalized_h_
38 #define _vpMomentAreaNormalized_h_
39 
40 #include <visp3/core/vpConfig.h>
41 #include <visp3/core/vpMoment.h>
42 
44 class vpMomentObject;
45 class vpMomentCentered;
46 
138 class VISP_EXPORT vpMomentAreaNormalized : public vpMoment
139 {
140 private:
141  double desiredSurface;
142  double desiredDepth;
143 
144 public:
145  vpMomentAreaNormalized(double a_star, double Z_star);
146  void compute();
147 
151  double getDesiredArea() const { return desiredSurface; }
152 
156  double getDesiredDepth() const { return desiredDepth; }
157 
162  void setDesiredDepth(double Z_star) { desiredDepth = Z_star; }
163 
168  void setDesiredArea(double a_star) { desiredSurface = a_star; }
169 
170 #if defined(VISP_BUILD_DEPRECATED_FUNCTIONS)
179  VP_DEPRECATED double getDesiredSurface() const { return desiredSurface; }
181 #endif
182 
186  const std::string name() const { return "vpMomentAreaNormalized"; }
187  friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpMomentAreaNormalized &v);
188  void printDependencies(std::ostream &os) const;
189 };
190 END_VISP_NAMESPACE
191 #endif
Class handling the normalized surface moment that is invariant in scale and used to estimate depth.
void setDesiredDepth(double Z_star)
void setDesiredArea(double a_star)
const std::string name() const
VP_DEPRECATED double getDesiredSurface() const
This class defines the double-indexed centered moment descriptor .
Class for generic objects.
This class defines shared methods/attributes for 2D moments.
Definition: vpMoment.h:106
friend VISP_EXPORT std::ostream & operator<<(std::ostream &os, const vpMoment &m)
Definition: vpMoment.cpp:50
virtual void compute()=0
virtual void printDependencies(std::ostream &os) const
Definition: vpMoment.cpp:134