00001
00002 /***************************************************************************
00003  *  shapemodel.cpp - Abstract class defining a shape model
00004  *
00005  *  Generated: Wed Mar 21 17:53:39 2007
00006  *  Copyright  2005-2007  Tim Niemueller [www.niemueller.de]
00007  *             2005       Martin Heracles <Martin.Heracles@rwth-aachen.de>
00008  *             2005       Hu Yuxiao      <Yuxiao.Hu@rwth-aachen.de>
00009  *
00010  ****************************************************************************/
00011
00012 /*  This program is free software; you can redistribute it and/or modify
00013  *  it under the terms of the GNU General Public License as published by
00014  *  the Free Software Foundation; either version 2 of the License, or
00015  *  (at your option) any later version. A runtime exception applies to
00016  *  this software (see LICENSE.GPL_WRE file mentioned below for details).
00017  *
00018  *  This program is distributed in the hope that it will be useful,
00019  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00020  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00021  *  GNU Library General Public License for more details.
00022  *
00023  *  Read the full text in the LICENSE.GPL_WRE file in the doc directory.
00024  */
00025
00026 #include <models/shape/shapemodel.h>
00027
00028 
00029 /** @class Shape <models/shape/shapemodel.h>
00030  * Shape interface.
00031  * Generic API for accessing using shapes.
00032  *
00033  * @fn void Shape::setMargin(unsigned int margin)
00034  * Set margin around shape
00035  * @param margin margin
00036  *
00037  * @fn bool Shape::isClose(unsigned int in_roi_x, unsigned int in_roi_y)
00038  * Check if the given point is close to the shape.
00039  * @param in_roi_x x coordinate of point in the same ROI as the shape
00040  * @param in_roi_y y coordinate of point in the same ROI as the shape
00041  */
00042 
00043 /** Virtual empty destructor. */
00044 Shape::~Shape()
00045 {
00046 }
00047
00048 
00049 /** @class ShapeModel <models/shape/shapemodel.h>
00050  * Shape model interface.
00051  *
00052  *
00053  * @fn std::string ShapeModel::getName(void) const
00054  * Get name of shape model.
00055  * @return name of shape model.
00056  *
00057  * @fn int ShapeModel::parseImage( unsigned char* buffer, ROI *roi)
00058  * Parse image for given ROI.
00059  * @param buffer image buffer
00060  * @param roi ROI
00061  * @return number of shapes found
00062  *
00063  * @fn int ShapeModel::getShapeCount(void) const
00064  * Get number of shapes.
00065  * @return number of shapes.
00066  *
00067  * @fn Shape* ShapeModel::getShape(int id) const
00068  * Get specific shape.
00069  * @param id shape ID
00070  * @return shape, do NOT free!
00071  *
00072  * @fn Shape* ShapeModel::getMostLikelyShape(void) const
00073  * Get best candidate.
00074  * @return best candidate shape, do not free.
00075  */
00076 
00077 /** Virtual empty destructor. */
00078 ShapeModel::~ShapeModel()
00079 {
00080 }