Fawkes API  Fawkes Development Version
shapemodel.cpp
1 
2 /***************************************************************************
3  * shapemodel.cpp - Abstract class defining a shape model
4  *
5  * Created: Wed Mar 21 17:53:39 2007
6  * Copyright 2005-2007 Tim Niemueller [www.niemueller.de]
7  * 2005 Martin Heracles <Martin.Heracles@rwth-aachen.de>
8  * 2005 Hu Yuxiao <Yuxiao.Hu@rwth-aachen.de>
9  *
10  ****************************************************************************/
11 
12 /* This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version. A runtime exception applies to
16  * this software (see LICENSE.GPL_WRE file mentioned below for details).
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU Library General Public License for more details.
22  *
23  * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
24  */
25 
26 #include <fvmodels/shape/shapemodel.h>
27 
28 namespace firevision {
29 #if 0 /* just to make Emacs auto-indent happy */
30 }
31 #endif
32 
33 /** @class Shape <fvmodels/shape/shapemodel.h>
34  * Shape interface.
35  * Generic API for accessing using shapes.
36  *
37  * @fn void Shape::setMargin(unsigned int margin)
38  * Set margin around shape
39  * @param margin margin
40  *
41  * @fn bool Shape::isClose(unsigned int in_roi_x, unsigned int in_roi_y)
42  * Check if the given point is close to the shape.
43  * @param in_roi_x x coordinate of point in the same ROI as the shape
44  * @param in_roi_y y coordinate of point in the same ROI as the shape
45  * @return true if point is close to shape, false otherwise
46  */
47 
48 /** Virtual empty destructor. */
50 {
51 }
52 
53 
54 /** @class ShapeModel <fvmodels/shape/shapemodel.h>
55  * Shape model interface.
56  *
57  *
58  * @fn std::string ShapeModel::getName(void) const
59  * Get name of shape model.
60  * @return name of shape model.
61  *
62  * @fn int ShapeModel::parseImage( unsigned char* buffer, ROI *roi)
63  * Parse image for given ROI.
64  * @param buffer image buffer
65  * @param roi ROI
66  * @return number of shapes found
67  *
68  * @fn int ShapeModel::getShapeCount(void) const
69  * Get number of shapes.
70  * @return number of shapes.
71  *
72  * @fn Shape* ShapeModel::getShape(int id) const
73  * Get specific shape.
74  * @param id shape ID
75  * @return shape, do NOT free!
76  *
77  * @fn Shape* ShapeModel::getMostLikelyShape(void) const
78  * Get best candidate.
79  * @return best candidate shape, do not free.
80  */
81 
82 /** Virtual empty destructor. */
84 {
85 }
86 
87 } // end namespace firevision
virtual ~Shape()
Virtual empty destructor.
Definition: shapemodel.cpp:49
virtual ~ShapeModel()
Virtual empty destructor.
Definition: shapemodel.cpp:83