cvrFixedGridInterpolation.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998-2004
 * 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   cvrFixedGridInterpolation.h
 *         Contains the class cvr::fixedGridInterpolation, which is
 *         parent class for all interpolation functors, whose samples have
 *         equal distances to each other (per dimension).
 * \author Peter Doerfler, Pablo Alvarado
 * \date   03.05.2003
 *
 * $Id: cvrFixedGridInterpolation.h,v 1.4 2007/09/10 02:47:54 alvarado Exp $
 */

#ifndef _CVR_FIXED_GRID_INTERPOLATION_H_
#define _CVR_FIXED_GRID_INTERPOLATION_H_


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

namespace cvr {

  /**
   * This abstract class parents all interpolation functors, whose
   * samples have equal distances to each other (per dimension),
   * i.e. data is in a vector or matrix which includes images.
   *
   *
   * @ingroup gInterpolator
   */
  template <typename T>
  class fixedGridInterpolation : public functor {
  public:

    /**
     * Definition of the type of the elements in the applys (given type T)
     */
    typedef T value_type;

    /**
     * The parameters for the class fixedGridInterpolation
     */
    class parameters : public functor::parameters {
    public:
      /**
       * Default constructor
       */
      parameters();

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

      /**
       * Constructor parameters with given with boundary type
       */
      parameters(const eBoundaryType btype);

      /**
       * 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 name of this class.
       */
      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
      // ------------------------------------------------

      /**
       * Specify how the boundaries will be used.
       *
       * See the documentation for cvr::eBoundaryType for more information
       *
       * Default: cvr::Zero
       */
      eBoundaryType boundaryType;
    };

    /**
     * Default constructor
     */
    fixedGridInterpolation();

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

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

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

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

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

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

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

    /**
     * all the next apply methods will return the interpolated values of the
     * given vector.
     */
    virtual bool use(const vector<T>& vct);

    /**
     * all the next apply methods will return the interpolated values of the
     * given matrix.
     */
    virtual bool use(const matrix<T>& vct);

    /**
     * Returns the interpolated value of the vector at the real valued
     * position x.
     * @param src vector<T> with the source data.
     * @param x the real valued position to be interpolated.
     * @return the interpolated value of the vector.
     */
    virtual T apply(const vector<T>& src,const float& x) const = 0;

    /**
     * Returns the interpolated value of the vector specified with
     * use() at the real valued position x.
     * @param x the real valued position to be interpolated.
     * @return the interpolated value of the vector.  */
    virtual T apply(const float& x) const = 0;

    /**
     * Returns the interpolated value of the matrix at the real valued
     * position (row,col).
     *
     * @param src matrix<T> with the source data.
     * @param row which row
     * @param col which column
     * @return the interpolated value of the matrix.
     */
    virtual T apply(const matrix<T>& src,
                    const float& row,
                    const float& col) const = 0;

    /**
     * Returns the interpolated value of the matrix at the real valued
     * position p.
     *
     * @param src matrix<T> with the source data.
     * @param p the real valued position to be interpolated.
     * @return the interpolated value of the matrix.
     */
    virtual T apply(const matrix<T>& src,const fpoint& p) const = 0;

    /**
     * Returns the interpolated value of the matrix specified with
     * use() at the real valued position (row,col).
     *
     * @param row which row
     * @param col which column
     * @return the interpolated value of the matrix.  */
    virtual T apply(const float& row, const float& col) const = 0;

    /**
     * Returns the interpolated value of the matrix specified with
     * use() at the real valued position p.
     *
     * @param p the real valued position to be interpolated.
     * @return the interpolated value of the matrix.
     */
    virtual T apply(const fpoint& p) const = 0;


    /**
     * Returns the interpolated value of the matrix at the real valued
     * position (row,col).  This method is NOT virtual and can be used
     * if this interpolation type is used as template parameter in time
     * critical situations.
     *
     * If not reimplemented in the inherited class, the virtual apply method
     * with the same signature will be called.
     *
     * @param src matrix<T> with the source data.
     * @param row which row
     * @param col which column
     * @return the interpolated value of the matrix.
     */
    inline T interpolate(const matrix<T>& src,
                         const float& row,
                         const float& col) const;

    /**
     * This method returns which pixel range around the interpolated postition
     * is considered by the interpolation functor.
     *
     * This is very useful for other functors to decide whether they should
     * call the interpolate() methods or the faster interpolateUnchk() methods.
     *
     * If the returned value is a and the interpolated position is (x,y) all
     * pixels with coordinates in \f$ [x-a .. x+a] \times [y-a .. y+a] \f$
     * may be considered by the interpolation functor.
     */
    virtual int getRangeOfInfluence() const = 0;

    /**
     * Shortcut for setting the boundary type of a functor derived from
     * modifier.
     *
     * \b Note: The boundaryType is modified via direct access to the
     * internal parameters object.
     */
    bool setBoundaryType(const eBoundaryType boundaryType);

  protected:
    /**
     * the vector in use
     */
    const vector<T>* theVector_;

    /**
     * the matrix in use
     */
    const matrix<T>* theMatrix_;

    /**
     * @name Boundary access operators
     *
     * These inline non-virtual methods are intended to be used by
     * inherited classes to access the extended versions of the at() matrix
     * access methods, for still integer indices.
     */
    //@{
    /**
     * Access with zero boundary
     */
    inline T zeroAt(const vector<T>& img,const int x) const;

    /**
     * Access with constant boundary
     */
    inline T cstAt(const vector<T>& img,const int x) const;

    /**
     * Access with mirrored boundary
     */
    inline T mirrAt(const vector<T>& img,const int x) const;

    /**
     * Access with periodic boundary
     */
    inline T periAt(const vector<T>& img,const int x) const;

    /**
     * Access with zero boundary
     */
    inline T zeroAt(const matrix<T>& img,const int y,const int x) const;

    /**
     * Access with constant boundary
     */
    inline T cstAt(const matrix<T>& img,const int y,const int x) const;

    /**
     * Access with mirrored boundary
     */
    inline T mirrAt(const matrix<T>& img,const int y,const int x) const;

    /**
     * Access with periodic boundary
     */
    inline T periAt(const matrix<T>& img,const int y,const int x) const;
    //@}

  };
}

#include "cvrFixedGridInterpolation_inline.h"
#include "cvrFixedGridInterpolation_template.h"

#endif