Mask1dGauss.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 __MASK1DGAUSS_H_INCLUDED__
#define __MASK1DGAUSS_H_INCLUDED__


/**
 * @file   Mask1dGauss.H
 * @brief  Header file of class qgar::Mask1dGauss.
 *
 * @author <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Karl Tombre">Karl Tombre</a>
 * @date   July 03, 2001  11:28
 * @since  Qgar 1.0
 */


// For RCS/CVS use: Do not delete
/* $Id: Mask1dGauss.H,v 1.9 2005/01/31 14:16:07 masini Exp $ */



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



namespace qgar
{

/**
 * @class Mask1dGauss Mask1dGauss.H "qgarlib/Mask1dGauss.H"
 * @ingroup DS_MASK
 * @brief 1D Gaussian convolution mask
 *
 * The code implementing this class is an adaptation of code written by
 * Carsten Steger at TU Muenchen, Germany. Here is the copyright notice
 * from his code:
@verbatim
 +----------------------------------------------------------------------+
 | Copyright (C) 1996 Carsten Steger                                    |
 |                                                                      |
 | This program is free software; you can redistribute it and/or modify |
 | it under the terms of the GNU General Public License as published by |
 | the Free Software Foundation; either version 2, or (at your option)  |
 | any later version.                                                   |
 |                                                                      |
 | This program 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    |
 | General Public License for more details.                             |
 |                                                                      |
 | You should have received a copy of the GNU General Public License    |
 | along with this program; if not, write to the Free Software          |
 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.            |
 +----------------------------------------------------------------------+
@endverbatim
 *
 * @author <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Karl Tombre">Karl Tombre</a>
 * @date   July 03, 2001  11:28
 * @since  Qgar 1.0
 */
class Mask1dGauss

  : public DMask1d

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

  /** @name CONSTRUCTOR */
  //        ===========
  //@{
  /**
   * @brief Copy constructor.
   *
   * See also qgar::Mask1dGauss::operator=,
   *          qgar::GenMask1d::deepCopy,
   *      and qgar::GenMask1d::shallowCopy.
   *
   * @warning Perform a deep copy: The coefficent map of the source mask
   * is duplicated.
   */
  Mask1dGauss(const Mask1dGauss& aMask);

  /**
   * @brief Initialize from given sigma (default <b>1.0</b>).
   * @param aSigma sigma of the Gaussian
   */
  Mask1dGauss(double aSigma = 1.0);
  //@}

  /** @name DESTRUCTOR */
  //        ==========
  //@{
  /**
   * @brief Virtual destructor.
   */
  virtual ~Mask1dGauss();
  //@}

  /** @name OPERATORS */
  //        =========
  //@{
  /**
   * @brief Assignment.
   * @param aMask mask to assign
   *
   * See also qgar::Mask1dGauss(Mask1dGauss&),
   *          qgar::GenMask1d::deepCopy,
   *      and qgar::GenMask1d::shallowCopy.
   *
   * @warning Perform a <b>deep copy</b>: The coefficient map 
   * of the source mask is duplicated. Before the copy is performed, 
   * the destination mask is not supposed to have the same size
   * as the destination mask.
   */
  Mask1dGauss& operator=(const Mask1dGauss& aMask);
  //@}

// -------------------------------------------------------------------
}; // class Mask1dGauss


} // namespace qgar

#endif /* __MASK1DGAUSS_H_INCLUDED__ */