00001 /*---------------------------------------------------------------------+ 00002 | Library QgarLib, graphics analysis and recognition | 00003 | Copyright (C) 2002 Qgar Project, LORIA | 00004 | | 00005 | This library is free software; you can redistribute it and/or | 00006 | modify it under the terms of the GNU Lesser General Public | 00007 | License version 2.1, as published by the Free Software Foundation. | 00008 | | 00009 | This library is distributed in the hope that it will be useful, | 00010 | but WITHOUT ANY WARRANTY; without even the implied warranty of | 00011 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | 00012 | See the GNU Lesser General Public License for more details. | 00013 | | 00014 | The GNU Lesser General Public License is included in the file | 00015 | LICENSE.LGPL, in the root directory of the Qgar packaging. See | 00016 | http://www.gnu.org/licenses/lgpl.html for the terms of the licence. | 00017 | To receive a paper copy, write to the Free Software Foundation, | 00018 | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. | 00019 | | 00020 | Contact Project Qgar for any information: | 00021 | LORIA - équipe Qgar | 00022 | B.P. 239, 54506 Vandoeuvre-lès-Nancy Cedex, France | 00023 | email: qgar-contact@loria.fr | 00024 | http://www.qgar.org/ | 00025 *---------------------------------------------------------------------*/ 00026 00027 00028 #ifndef __GRADIENTMODULEIMAGE_H_INCLUDED__ 00029 #define __GRADIENTMODULEIMAGE_H_INCLUDED__ 00030 00031 00032 /** 00033 * @file GradientModuleImage.H 00034 * @brief Header file of class qgar::GradientModuleImage. 00035 * 00036 * @author <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Karl Tombre">Karl Tombre</a> 00037 * @date July 3, 2001 15:21 00038 * @since Qgar 1.0 00039 */ 00040 00041 // For RCS/CVS use: Do not delete 00042 /* $Id: GradientModuleImage.H,v 1.12 2005/07/29 16:28:09 gerald Exp $ */ 00043 00044 00045 00046 // QGAR 00047 #include <qgarlib/GenImage.H> 00048 namespace qgar 00049 { 00050 // Avoid #include's when not necessary 00051 class AbstractGradientImage; 00052 } 00053 00054 00055 00056 namespace qgar 00057 { 00058 00059 00060 /** 00061 * @class GradientModuleImage GradientModuleImage.H "qgarlib/GradientModuleImage.H" 00062 * @ingroup IMGPROC_GRAD 00063 * @brief Module of the Gradient of an image. 00064 */ 00065 class GradientModuleImage 00066 00067 : public FloatImage 00068 00069 { 00070 // ------------------------------------------------------------------- 00071 // T Y P E D E F I N I T I O N S 00072 // ------------------------------------------------------------------- 00073 public: 00074 00075 00076 /** @name Types */ 00077 // ===== 00078 //@{ 00079 00080 /** 00081 * @brief Type of the elements stored in the pixmap. 00082 */ 00083 typedef FloatImage::value_type value_type; 00084 00085 /** 00086 * @brief Reference to qgar::GenImage::value_type. 00087 */ 00088 typedef value_type& reference; 00089 00090 /** 00091 * @brief Constant reference to qgar::GenImage::value_type. 00092 */ 00093 typedef const value_type& const_reference; 00094 00095 /** 00096 * @brief Pointer to qgar::GenImage::value_type. 00097 */ 00098 typedef value_type* pointer; 00099 00100 /** 00101 * @brief Constant pointer to qgar::GenImage::value_type. 00102 */ 00103 typedef const value_type* const_pointer; 00104 00105 //@} 00106 00107 00108 // ------------------------------------------------------------------- 00109 // P U B L I C M E M B E R S 00110 // ------------------------------------------------------------------- 00111 public: 00112 00113 /** @name Constructors */ 00114 // ============ 00115 //@{ 00116 00117 /** 00118 * @brief Construct from given gradient image. 00119 * 00120 * @param aGradImg a Gradient image 00121 */ 00122 explicit GradientModuleImage(AbstractGradientImage& aGradImg); 00123 00124 //@} 00125 00126 // ------------------------------------------------------------------- 00127 }; // class GradientModuleImage 00128 00129 00130 } // namespace qgar 00131 00132 00133 #endif /* __GRADIENTMODULEIMAGE_H_INCLUDED__ */