Visual Servoing Platform  version 3.6.1 under development (2024-10-10)
vpFeatureMomentBasic.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  * Implementation for all supported moment features.
32  */
33 
40 #ifndef _vpFeatureMomentBasic_h_
41 #define _vpFeatureMomentBasic_h_
42 
43 #include <visp3/core/vpMomentCommon.h>
44 #include <visp3/core/vpMomentObject.h>
45 #include <visp3/visual_features/vpFeatureMoment.h>
46 
47 BEGIN_VISP_NAMESPACE
48 class vpMomentDatabase;
77 class VISP_EXPORT vpFeatureMomentBasic : public vpFeatureMoment
78 {
79 protected:
80  unsigned int order;
81 
82 public:
83  vpFeatureMomentBasic(vpMomentDatabase &moments, double A, double B, double C,
84  vpFeatureMomentDatabase *featureMoments = nullptr);
85 
86  void compute_interaction() VP_OVERRIDE;
87 
88 #ifndef DOXYGEN_SHOULD_SKIP_THIS
89  /* Add function due to pure virtual definition in vpBasicFeature.h */
90  vpMatrix interaction(unsigned int /* select = FEATURE_ALL */) VP_OVERRIDE
91  {
92  throw vpException(vpException::functionNotImplementedError, "Not implemented!");
93  }
94 #endif
95 
96  vpMatrix interaction(unsigned int select_one, unsigned int select_two) const;
97 
101  const std::string momentName() const VP_OVERRIDE
102  {
103  return "vpMomentBasic";
104  }
105 
109  const std::string name() const VP_OVERRIDE
110  {
111  return "vpFeatureMomentBasic";
112  }
113 };
114 END_VISP_NAMESPACE
115 #endif
error that can be emitted by ViSP classes.
Definition: vpException.h:60
@ functionNotImplementedError
Function not implemented.
Definition: vpException.h:66
Functionality computation for basic moment feature. Computes the interaction matrix associated with v...
const std::string name() const VP_OVERRIDE
const std::string momentName() const VP_OVERRIDE
This class allows to register all feature moments (implemented in vpFeatureMoment....
This class defines shared system methods/attributes for 2D moment features but no functional code....
vpMatrix interaction(unsigned int select=FEATURE_ALL) VP_OVERRIDE
virtual void compute_interaction(void)
Implementation of a matrix and operations on matrices.
Definition: vpMatrix.h:169
This class allows to register all vpMoments so they can access each other according to their dependen...