cvrFilledUpsampling.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998 - 2005
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * 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   cvrFilledUpsampling.h
 * \author Pablo Alvarado
 * \author Jochen Wickel
 * \date   12.5.2000
 *
 * $Id: cvrFilledUpsampling.h,v 1.4 2005/05/08 18:29:47 arndh Exp $
 */

#ifndef _CVR_FILLEDUPSAMPLING_H_
#define _CVR_FILLEDUPSAMPLING_H_

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

namespace cvr {
  /**
   * Filled upsampling (or upsampling with zero-order interpolation)
   *
   * The class cvr::filledUpsampling takes some image or channel and transforms
   * each pixel to a filled square. This could also be obtained with the
   * upsampling functor and an appropriate kernel, but this one is much faster,
   * since it omits all convolution overhead.
   *
   * @ingroup gLinearFilters
   */
  class filledUpsampling : public functor {
  public:
    /**
     * The parameters for the class cvr::filledUpsampling
     */
    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();

      /**
       * Returns name of this type
       */
      const std::string& name() const;

      /** 
       * 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);

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

      /**
       * Returns a pointer to a new instance of the parameters
       */
      virtual filledUpsampling::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;

      /**
       * 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 read(ioHandler& handler,const bool complete=true);

      /**
       * Upsampling factor.
       *
       * The x component is meant for the horizontal upsampling and the y
       * component for the vertical upsampling.
       *
       * If you are filtering vectors, only the x component will be used.
       *
       * Default value: (2,2)
       */
      ipoint factor;
    };

    /**
     * Default constructor
     */
    filledUpsampling();

    /**
     * Constructor to give directly the scaling factor
     */
    filledUpsampling(const ipoint& factor);

    /**
     * Constructor to give directly the scaling factor
     */
    filledUpsampling(const int factor);

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

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

    /**
     * Returns the name of this type
     */
    virtual const std::string& name() const;

    /**
     * Operates on the given parameter.
     *
     * @param srcdest channel or matrix with the source data.  The result
     *                will be left here too.
     * @return true if successful, false otherwise.
     */
    template<typename T>
    bool apply(matrix<T>& srcdest) const;

    /** 
     * Operates on the given parameter.
     * @param srcdest vector with the source data.
     *                The result will be left here too.
     * @return true if successful, false otherwise.
     */
    template<typename T>
    bool apply(vector<T>& srcdest) const;

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

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

    /**
     * Operates on the given parameter.
     * @param factor upsampling factor (this method ignores the value in
     *               the parameters).
     * @param srcdest channel or matrix with the source data.  The result
     *                will be left here too.
     * @return true if successful, false otherwise.
     */
    template<typename T>
    bool apply(const ipoint& factor,
                     matrix<T>& srcdest) const;

    /** 
     * Operates on the given parameter.
     * @param factor upsampling factor (this method ignores the value in
     *               the parameters).
     * @param srcdest vector with the source data.
     *                The result will be left here too.
     * @return true if successful, false otherwise.
     */
    template<typename T>
    bool apply(const int factor,vector<T>& srcdest) const;

    /** 
     * Operates on a copy of the given parameters.
     * @param factor upsampling factor (this method ignores the value in
     *               the parameters).
     * @param src channel or matrix with the source data.
     * @param dest channel or matrix where the result will be left.
     * @return true if successful, false otherwise.
     */
    template<typename T>
    bool apply(const ipoint& factor,
               const matrix<T>& src,
                     matrix<T>& dest) const;

    /** 
     * Operates on a copy of the given parameters.
     *
     * @param factor upsampling factor (this method ignores the value in
     *               the parameters).
     * @param src vector with the source data.
     * @param dest vector where the result will be left.
     * @return true if successful, false otherwise.
     */
    template<typename T>
    bool apply(const int factor,
               const vector<T>& src,
                     vector<T>& dest) const;


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

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

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

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

#include "cvrFilledUpsampling_template.h"

#endif