Fawkes API
Fawkes Development Version
|
00001 00002 /*************************************************************************** 00003 * shapemodel.cpp - Abstract class defining a shape model 00004 * 00005 * Created: 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 namespace firevision { 00029 #if 0 /* just to make Emacs auto-indent happy */ 00030 } 00031 #endif 00032 00033 /** @class Shape <models/shape/shapemodel.h> 00034 * Shape interface. 00035 * Generic API for accessing using shapes. 00036 * 00037 * @fn void Shape::setMargin(unsigned int margin) 00038 * Set margin around shape 00039 * @param margin margin 00040 * 00041 * @fn bool Shape::isClose(unsigned int in_roi_x, unsigned int in_roi_y) 00042 * Check if the given point is close to the shape. 00043 * @param in_roi_x x coordinate of point in the same ROI as the shape 00044 * @param in_roi_y y coordinate of point in the same ROI as the shape 00045 * @return true if point is close to shape, false otherwise 00046 */ 00047 00048 /** Virtual empty destructor. */ 00049 Shape::~Shape() 00050 { 00051 } 00052 00053 00054 /** @class ShapeModel <models/shape/shapemodel.h> 00055 * Shape model interface. 00056 * 00057 * 00058 * @fn std::string ShapeModel::getName(void) const 00059 * Get name of shape model. 00060 * @return name of shape model. 00061 * 00062 * @fn int ShapeModel::parseImage( unsigned char* buffer, ROI *roi) 00063 * Parse image for given ROI. 00064 * @param buffer image buffer 00065 * @param roi ROI 00066 * @return number of shapes found 00067 * 00068 * @fn int ShapeModel::getShapeCount(void) const 00069 * Get number of shapes. 00070 * @return number of shapes. 00071 * 00072 * @fn Shape* ShapeModel::getShape(int id) const 00073 * Get specific shape. 00074 * @param id shape ID 00075 * @return shape, do NOT free! 00076 * 00077 * @fn Shape* ShapeModel::getMostLikelyShape(void) const 00078 * Get best candidate. 00079 * @return best candidate shape, do not free. 00080 */ 00081 00082 /** Virtual empty destructor. */ 00083 ShapeModel::~ShapeModel() 00084 { 00085 } 00086 00087 } // end namespace firevision