libvisp-core-dev 3.0.0-4 / usr / include / x86_64-linux-gnu / visp3 / core / vpMoment.h

This file is indexed.

/usr/include/x86_64-linux-gnu/visp3/core/vpMoment.h is in libvisp-core-dev 3.0.0-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/****************************************************************************
 *
 * This file is part of the ViSP software.
 * Copyright (C) 2005 - 2015 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
 * ("GPL") version 2 as published by the Free Software Foundation.
 * 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 http://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
 *
 * Authors:
 * Filip Novotny
 *
 *****************************************************************************/

/*!
  \file vpMoment.h
  \brief Base class for all 2D moments.
*/

#ifndef __MOMENT_H__
#define __MOMENT_H__

#include <vector>
#include <iostream>

#include <visp3/core/vpConfig.h>
#include <visp3/core/vpException.h>


class vpMomentDatabase;
class vpMomentObject;


/*!
  \class vpMoment

  \ingroup group_core_moments

  \brief This class defines shared methods/attributes for 2D moments.

  All moments or combination of moments in the moments module are based on this class.
  A moment uses a vpMomentObject object to access all useful information.
  Moment values are obtained by a 4-step process common for all moment types:
  - Declaration.
  \code
  vpMoment moment;
  \endcode
  - Update with object.
  \code
  moment.update(object);
  \endcode
  - Compute the moment value
  \code
  moment.compute();
  \endcode
  - Access the values:
  \code
  std::vector<double> values = moment.get();
  \endcode

  A moment may also be linked to a vpMomentDatabase. Moments linked to a database are able to access each others values.
  Some moments can be computed only if they are linked to a a database containing their dependencies.
  Linking to a database is done using the vpMoment::linkTo(...) method.

  There are no constraints about format of the array returned by vpMoment::get(); any implementation is fine.

  Each moment must have a string name by implementing the char* vpMoment::name() method which allows to identify the moment in the database.
  Each moment must also implement a compute method describing how to obtain its values from the object.

  \attention Order of moment computation DOES matter: when you compute a moment using vpMoment::compute(),
  all moment dependencies must be computed.
  We recall that implemented moments are:
  - vpMomentAlpha
  - vpMomentArea
  - vpMomentAreaNormalized
  - vpMomentBasic
  - vpMomentCentered
  - vpMomentCInvariant
  - vpMomentGravityCenter
  - vpMomentGravityCenterNormalized

*/
class VISP_EXPORT vpMoment
{
private:
  vpMomentObject* object;
  vpMomentDatabase* moments;
  char _name[255];

protected:
  std::vector<double> values;
  /*!
     Returns the linked moment database.
     \return the moment database
   */
  inline vpMomentDatabase& getMoments() const { return *moments; }

//private:
//#ifndef DOXYGEN_SHOULD_SKIP_THIS
//  vpMoment(const vpMoment &)
//    : object(NULL), moments(NULL), values()
//  {
//    throw vpException(vpException::functionNotImplementedError,"Not implemented!");
//  }
//  vpMoment &operator=(const vpMoment &){
//    throw vpException(vpException::functionNotImplementedError,"Not implemented!");
//    return *this;
//  }
//#endif

public:
  vpMoment();

  /*!
     Virtual destructor.
   */
  virtual ~vpMoment() {}

  virtual void compute()=0;
  inline const vpMomentObject& getObject() const { return *object;}
  /*!
     Returns all values computed by the moment.
     \return vector of values
   */
  const std::vector<double>& get() const { return values;}
  void linkTo(vpMomentDatabase& moments);
  virtual const char* name() const = 0;
  friend VISP_EXPORT std::ostream & operator<<(std::ostream & os, const vpMoment& m);
  virtual void printDependencies(std::ostream& os) const;
  void update(vpMomentObject& object);

};
#endif

APT Browse - Built by Thomas Orozco.