CleanedBinaryImage.H

Go to the documentation of this file.

/*---------------------------------------------------------------------+
 | Library QgarLib, graphics analysis and recognition                  |
 | Copyright (C) 2002  Qgar Project, LORIA                             |
 |                                                                     |
 | This library is free software; you can redistribute it and/or       |
 | modify it under the terms of the GNU Lesser General Public          |
 | License version 2.1, as published by the Free Software Foundation.  |
 |                                                                     |
 | This library is distributed in the hope that it will be useful,     |
 | but WITHOUT ANY WARRANTY; without even the implied warranty of      |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                |
 | See the GNU Lesser General Public License for more details.         |
 |                                                                     |
 | The GNU Lesser General Public License is included in the file       |
 | LICENSE.LGPL, in the root directory of the Qgar packaging. See      |
 | http://www.gnu.org/licenses/lgpl.html for the terms of the licence. |
 | To receive a paper copy, write to the Free Software Foundation,     |
 | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.       |
 |                                                                     |
 | Contact Project Qgar for any information:                           |
 |   LORIA - équipe Qgar                                               |
 |   B.P. 239, 54506 Vandoeuvre-lès-Nancy Cedex, France                |
 |   email: qgar-contact@loria.fr                                      |
 |   http://www.qgar.org/                                              |
 *---------------------------------------------------------------------*/


#ifndef __CLEANEDBINARYIMAGE_H_INCLUDED__
#define __CLEANEDBINARYIMAGE_H_INCLUDED__


/**
 * @file   CleanedBinaryImage.H
 * @brief  Header file of class qgar::CleanedBinaryImage.
 *
 * @author <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Karl Tombre">Adlane Habed and Karl Tombre</a>
 * @date   July 4, 2001  17:29
 * @since  Qgar 2.1
 */


// For RCS/CVS use: Do not delete
/* $Id: CleanedBinaryImage.H,v 1.10 2005/10/14 17:05:45 masini Exp $ */



// QGAR
#include <qgarlib/GenImage.H>



namespace qgar
{

/**
 * @ingroup IMGPROC_CONVOL
 *
 * @class CleanedBinaryImage CleanedBinaryImage.H "qgarlib/CleanedBinaryImage.H"
 *
 * @brief A Cleaned binary image.
 *
 * Cleaning operations are:
 *
 * <ul>
 * <li>
 * Set center of following configurations to <b>0</b>:
@verbatim
  1 1 1   1 0 0   0 0 0   0 0 1   0 0 0
  0 1 0   1 1 0   0 1 0   0 1 1   0 1 0
  0 0 0   1 0 0   1 1 1   0 0 1   0 0 0
@endverbatim
 * </li>
 * <li>
 * Set center of following configurations to <b>1</b>:
@verbatim
    0 0 0   0 1 1   1 1 1   1 1 0   . 1 .
    1 0 1   0 0 1   1 0 1   1 0 0   1 0 1
    1 1 1   0 1 1   0 0 0   1 1 0   . 1 .
@endverbatim
 * </li>
 * </ul>
 *
 * @author <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Karl Tombre">Adlane Habed and Karl Tombre</a>
 * @date   July 4, 2001  17:29
 * @since  Qgar 2.1
 */
class CleanedBinaryImage

  : public BinaryImage

{
// -------------------------------------------------------------------
// T Y P E   D E F I N I T I O N S
// -------------------------------------------------------------------
public:


  /** @name Types */
  //        =====
  //@{

  /**
   * @brief Type of the elements stored in the pixel map.
   */
  typedef BinaryImage::value_type value_type;

  /**
   * @brief Reference to qgar::CleanedBinaryImage::value_type.
   */
  typedef value_type& reference;

  /**
   * @brief Constant reference to qgar::CleanedBinaryImage::value_type.
   */
  typedef const value_type& const_reference;

  /**
   * @brief Pointer to qgar::CleanedBinaryImage::value_type.
   */
  typedef value_type* pointer;

  /**
   * @brief Constant pointer to qgar::CleanedBinaryImage::value_type.
   */
  typedef const value_type* const_pointer;

  //@}


// -------------------------------------------------------------------
// P U B L I C    M E M B E R S
// -------------------------------------------------------------------
public:

  /** @name CONSTRUCTORS */
  //        ============
  //@{

  /**
   * @brief Construct from given binary image.
   *
   * @param img  a binary image
   */

  CleanedBinaryImage(const BinaryImage& img);

  //@}

// -------------------------------------------------------------------
}; // class CleanedBinaryImage

} // namespace qgar 


#endif /* __CLEANEDBINARYIMAGE_H_INCLUDED__ */