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
28namespace firevision {
29
30/** @class Shape <fvmodels/shape/shapemodel.h>
31 * Shape interface.
32 * Generic API for accessing using shapes.
33 *
34 * @fn void Shape::setMargin(unsigned int margin)
35 * Set margin around shape
36 * @param margin margin
37 *
38 * @fn bool Shape::isClose(unsigned int in_roi_x, unsigned int in_roi_y)
39 * Check if the given point is close to the shape.
40 * @param in_roi_x x coordinate of point in the same ROI as the shape
41 * @param in_roi_y y coordinate of point in the same ROI as the shape
42 * @return true if point is close to shape, false otherwise
43 */
44
45/** Virtual empty destructor. */
47{
48}
49
50/** @class ShapeModel <fvmodels/shape/shapemodel.h>
51 * Shape model interface.
52 *
53 *
54 * @fn std::string ShapeModel::getName(void) const
55 * Get name of shape model.
56 * @return name of shape model.
57 *
58 * @fn int ShapeModel::parseImage( unsigned char* buffer, ROI *roi)
59 * Parse image for given ROI.
60 * @param buffer image buffer
61 * @param roi ROI
62 * @return number of shapes found
63 *
64 * @fn int ShapeModel::getShapeCount(void) const
65 * Get number of shapes.
66 * @return number of shapes.
67 *
68 * @fn Shape* ShapeModel::getShape(int id) const
69 * Get specific shape.
70 * @param id shape ID
71 * @return shape, do NOT free!
72 *
73 * @fn Shape* ShapeModel::getMostLikelyShape(void) const
74 * Get best candidate.
75 * @return best candidate shape, do not free.
76 */
77
78/** Virtual empty destructor. */
80{
81}
82
83} // end namespace firevision
virtual ~ShapeModel()
Virtual empty destructor.
Definition: shapemodel.cpp:79
virtual ~Shape()
Virtual empty destructor.
Definition: shapemodel.cpp:46