Visual Servoing Platform  version 3.4.1 under development (2021-09-19)
vpMomentAreaNormalized.h
1 /****************************************************************************
2  *
3  * ViSP, open source Visual Servoing Platform software.
4  * Copyright (C) 2005 - 2019 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  * See the file LICENSE.txt at the root directory of this source
11  * distribution for additional information about the GNU GPL.
12  *
13  * For using ViSP with software that can not be combined with the GNU
14  * GPL, please contact Inria about acquiring a ViSP Professional
15  * Edition License.
16  *
17  * See http://visp.inria.fr for more information.
18  *
19  * This software was developed at:
20  * Inria Rennes - Bretagne Atlantique
21  * Campus Universitaire de Beaulieu
22  * 35042 Rennes Cedex
23  * France
24  *
25  * If you have questions regarding the use of this file, please contact
26  * Inria at visp@inria.fr
27  *
28  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
29  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
30  *
31  * Description:
32  * 2D normalized surface moment descriptor (usually described as An)
33  *
34  * Authors:
35  * Filip Novotny
36  *
37  *****************************************************************************/
42 #ifndef _vpMomentAreaNormalized_h_
43 #define _vpMomentAreaNormalized_h_
44 
45 #include <visp3/core/vpMoment.h>
46 
47 class vpMomentObject;
48 class vpMomentCentered;
49 
102 
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);
147  void compute();
151  double getDesiredArea() const { return desiredSurface; }
155  double getDesiredDepth() const { return desiredDepth; }
160  vp_deprecated double getDesiredSurface() const { return desiredSurface; }
165  void setDesiredDepth(double Z_star) { desiredDepth = Z_star; }
170  void setDesiredArea(double a_star) { desiredSurface = a_star; }
171 
175  const char *name() const { return "vpMomentAreaNormalized"; }
176  friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpMomentAreaNormalized &v);
177  void printDependencies(std::ostream &os) const;
178 };
179 
180 #endif
Class handling the normalized surface moment that is invariant in scale and used to estimate depth...
vp_deprecated double getDesiredSurface() const
Class for generic objects.
void setDesiredDepth(double Z_star)
This class defines shared methods/attributes for 2D moments.
Definition: vpMoment.h:110
This class defines the double-indexed centered moment descriptor .
void setDesiredArea(double a_star)
friend VISP_EXPORT std::ostream & operator<<(std::ostream &os, const vpMoment &m)
Definition: vpMoment.cpp:122
virtual void printDependencies(std::ostream &os) const
Definition: vpMoment.cpp:135
virtual void compute()=0