cvrBoundaryExpansion.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007
 * ITCR, Pablo Alvarado
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/**
 * \file   cvrBoundaryExpansion.h
 *         Contains the class cvr::boundaryExpansion,
 *         which is used to expand an image with a border defined through the
 *         boundaryType parameter
 *
 * \author Pablo Alvarado
 * \date   03.10.2007
 *
 * revisions ..: $Id: cvrBoundaryExpansion.h,v 1.1 2007/10/05 00:46:15 alvarado Exp $
 */

#ifndef _CVR_BOUNDARY_EXPANSION_H_
#define _CVR_BOUNDARY_EXPANSION_H_

#include "cvrMatrix.h"
#include "cvrVector.h"
#include "cvrFunctor.h"
#include "cvrTypeInfo.h"
#include "cvrBoundaryType.h"

namespace cvr {

  /**
   * Class boundaryExpansion
   *
   * This class is used to expand the border of an image and fill it according
   * to the boundary type specified in the parameters.  It is employed by
   * several functors to work using "internal" pixels only, without worring
   * about the specific border type to be used.
   *
   * If negative values of border are given in the parameters, the image will
   * be clipped.
   *
   * @see boundaryExpansion::parameters.
   *
   * @ingroup gGeometricTrans
   */
  class boundaryExpansion : public functor {
  public:
    /**
     * The parameters for the class boundaryExpansion
     */
    class parameters : public functor::parameters {
    public:
      /**
       * Default constructor
       */
      parameters();

      /**
       * Copy constructor
       * @param other the parameters object to be copied
       */
      parameters(const parameters& other);

      /**
       * Destructor
       */
      ~parameters();

      /**
       * Copy the contents of a parameters object
       * @param other the parameters object to be copied
       * @return a reference to this parameters object
       */
      parameters& copy(const parameters& other);

      /**
       * Copy the contents of a parameters object
       * @param other the parameters object to be copied
       * @return a reference to this parameters object
       */
      parameters& operator=(const parameters& other);

      /**
       * Returns the complete name of the parameters class.
       */
      virtual const std::string& name() const;

      /**
       * Returns a pointer to a clone of the parameters.
       */
      virtual parameters* clone() const;

      /**
       * Returns a pointer to a new instance of the parameters.
       */
      virtual parameters* newInstance() const;

      /**
       * Write the parameters in the given ioHandler
       * @param handler the ioHandler to be used
       * @param complete if true (the default) the enclosing begin/end will
       *        be also written, otherwise only the data block will be written.
       * @return true if write was successful
       */
      virtual bool write(ioHandler& handler,const bool complete=true) const;

      /**
       * Read the parameters from the given ioHandler
       * @param handler the ioHandler to be used
       * @param complete if true (the default) the enclosing begin/end will
       *        be also written, otherwise only the data block will be written.
       * @return true if write was successful
       */
      virtual bool read(ioHandler& handler,const bool complete=true);

      // ------------------------------------------------
      // the parameters
      // ------------------------------------------------

      /**
       * Number of pixels in the bottom border.
       *
       * Default value: 5
       */
      int bottomBorder;

      /**
       * Number of pixels in the left border.
       *
       * Default value: 5
       */
      int leftBorder;

      /**
       * Number of pixels in the right border.
       *
       * Default value: 5
       */
      int rightBorder;

      /**
       * Number of pixels in the top border.
       *
       * Default value: 5
       */
      int topBorder;

      /**
       * Type of boundary expansion
       */
      eBoundaryType boundaryType;

      /**
       * Normalization.
       *
       * If set to \c true, then the values will be normalized and denormalized
       * when transfering the data from one matrix of one type to a matrix of
       * another type, so that the values preserve their nature.  For instance,
       * when converting ubyte to float, the values will be divided by 255 to
       * produce values between 0.0f and 1.0f, or the other way around. The
       * normalization constants are given by
       * cvr::typeInfo<T>::suggestedNorm().
       *
       * If set to \c false then the values are simply casted.
       *
       * Default value: false
       */
      bool normalize;

    };

    /**
     * Default constructor
     */
    boundaryExpansion();

    /**
     * Construct a functor with a border of homogeneous width all around, and
     * the given boundary type.
     *
     * @param width width of the border
     * @param type boundary type
     * @param normalize indicate if normalization by the type conversion has
     *                  to be made.
     */
    boundaryExpansion(const int width,
                      const eBoundaryType type = Zero,
                      const bool normalize = false);

    /**
     * Construct a functor using the given parameters
     */
    boundaryExpansion(const parameters& par);

    /**
     * Copy constructor
     * @param other the object to be copied
     */
    boundaryExpansion(const boundaryExpansion& other);

    /**
     * Destructor
     */
    virtual ~boundaryExpansion();

    /**
     * Expand the boundary of the given matrix and leave the result on the
     * same matrix.
     *
     * @param srcdest matrix<T> with the source data. The result
     *                will be left here too.
     * @return true if apply successful or false otherwise.
     */
    template<typename T>
    bool apply(matrix<T>& srcdest) const;

    /**
     * Operates on a copy of the given arguments.
     *
     * @param src matrix<T> with the source data.
     * @param dest matrix<T> where the result will be left.
     * @return true if apply successful or false otherwise.
     */
    template<typename T,typename U>
    bool apply(const matrix<T>& src, matrix<U>& dest) const;

    /**
     * Copy data of "other" functor.
     * @param other the functor to be copied
     * @return a reference to this functor object
     */
    boundaryExpansion& copy(const boundaryExpansion& other);

    /**
     * Alias for copy member
     * @param other the functor to be copied
     * @return a reference to this functor object
     */
    boundaryExpansion& operator=(const boundaryExpansion& other);

    /**
     * Returns the complete name of the functor class
     */
    virtual const std::string& name() const;

    /**
     * Returns a pointer to a clone of this functor.
     */
    virtual boundaryExpansion* clone() const;

    /**
     * Returns a pointer to a new instance of this functor.
     */
    virtual boundaryExpansion* newInstance() const;

    /**
     * Returns used parameters
     */
    const parameters& getParameters() const;

  private:
    /**
     * The class doing the real job
     */
    template<typename T,typename U,bool N>
    class helperBase;

    /**
     * The class doing the real job
     */
    template<typename T,typename U,bool N>
    class helper;
  };
}

#include "cvrBoundaryExpansion_template.h"

#endif