multi_resize.hxx

/************************************************************************/
/*                                                                      */
/*               Copyright 1998-2004 by Ullrich Koethe                  */
/*                                                                      */
/*    This file is part of the VIGRA computer vision library.           */
/*    The VIGRA Website is                                              */
/*        http://hci.iwr.uni-heidelberg.de/vigra/                       */
/*    Please direct questions, bug reports, and contributions to        */
/*        ullrich.koethe@iwr.uni-heidelberg.de    or                    */
/*        vigra@informatik.uni-hamburg.de                               */
/*                                                                      */
/*    Permission is hereby granted, free of charge, to any person       */
/*    obtaining a copy of this software and associated documentation    */
/*    files (the "Software"), to deal in the Software without           */
/*    restriction, including without limitation the rights to use,      */
/*    copy, modify, merge, publish, distribute, sublicense, and/or      */
/*    sell copies of the Software, and to permit persons to whom the    */
/*    Software is furnished to do so, subject to the following          */
/*    conditions:                                                       */
/*                                                                      */
/*    The above copyright notice and this permission notice shall be    */
/*    included in all copies or substantial portions of the             */
/*    Software.                                                         */
/*                                                                      */
/*    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND    */
/*    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES   */
/*    OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND          */
/*    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT       */
/*    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,      */
/*    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING      */
/*    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR     */
/*    OTHER DEALINGS IN THE SOFTWARE.                                   */
/*                                                                      */
/************************************************************************/


#ifndef VIGRA_MULTI_RESIZE_HXX
#define VIGRA_MULTI_RESIZE_HXX

#include <vector>
#include "resizeimage.hxx"
#include "navigator.hxx"
#include "multi_shape.hxx"

namespace vigra {

namespace detail {

template <class SrcIterator, class Shape, class SrcAccessor,
          class DestIterator, class DestAccessor, class Kernel>
void
internalResizeMultiArrayOneDimension(
                      SrcIterator si, Shape const & sshape, SrcAccessor src,
                      DestIterator di, Shape const & dshape, DestAccessor dest,
                      Kernel const & spline, unsigned int d)
{
    enum { N = 1 + SrcIterator::level };

    typedef typename NumericTraits<typename DestAccessor::value_type>::RealPromote TmpType;

    typedef MultiArrayNavigator<SrcIterator, N> SNavigator;
    typedef MultiArrayNavigator<DestIterator, N> DNavigator;

    SNavigator snav( si, sshape, d );
    DNavigator dnav( di, dshape, d );

    int ssize = sshape[d];
    int dsize = dshape[d];

    vigra_precondition(ssize > 1,
                 "resizeMultiArraySplineInterpolation(): "
                 "Source array too small.\n");

    Rational<int> ratio(dsize - 1, ssize - 1);
    Rational<int> offset(0);
    resampling_detail::MapTargetToSourceCoordinate mapCoordinate(ratio, offset);
    int period = lcm(ratio.numerator(), ratio.denominator());

    ArrayVector<double> const & prefilterCoeffs = spline.prefilterCoefficients();
    ArrayVector<Kernel1D<double> > kernels(period);
    createResamplingKernels(spline, mapCoordinate, kernels);

    // temporary array to hold the current line to enable in-place operation
    ArrayVector<TmpType> tmp( ssize );
    typename ArrayVector<TmpType>::iterator t = tmp.begin(), tend = tmp.end();
    typename AccessorTraits<TmpType>::default_accessor ta;

    for( ; snav.hasMore(); snav++, dnav++ )
    {
        // first copy source to temp for maximum cache efficiency
        copyLine( snav.begin(), snav.end(), src, t, ta);

        for(unsigned int b = 0; b < prefilterCoeffs.size(); ++b)
        {
            recursiveFilterLine(t, tend, ta, t, ta,
                                prefilterCoeffs[b], BORDER_TREATMENT_REFLECT);
        }
        resamplingConvolveLine(t, tend, ta,
                               dnav.begin(), dnav.begin() + dsize, dest,
                               kernels, mapCoordinate);
    }
}

} // namespace detail

/** \addtogroup GeometricTransformations
*/
//@{


/***************************************************************/
/*                                                             */
/*             resizeMultiArraySplineInterpolation             */
/*                                                             */
/***************************************************************/

/** \brief Resize MultiArray using B-spline interpolation.

    <b> Declarations:</b>

    pass arbitrary-dimensional array views:
    \code
    namespace vigra {
        template <unsigned int N, class T1, class S1,
                                  class T2, class S2,
                  class Kernel = BSpline<3, double> >
        void
        resizeMultiArraySplineInterpolation(MultiArrayView<N, T1, S1> const & source,
                                            MultiArrayView<N, T2, S2> dest,
                                            Kernel const & spline = BSpline<3, double>());
    }
    \endcode

    \deprecatedAPI{resizeMultiArraySplineInterpolation}
    pass \ref MultiIteratorPage "MultiIterators" and \ref DataAccessors :
    \code
    namespace vigra {
        template <class SrcIterator, class Shape, class SrcAccessor,
                  class DestIterator, class DestAccessor,
                  class Kernel = BSpline<3, double> >
        void
        resizeMultiArraySplineInterpolation(
                              SrcIterator si, Shape const & sshape, SrcAccessor src,
                              DestIterator di, Shape const & dshape, DestAccessor dest,
                              Kernel const & spline = BSpline<3, double>());
    }
    \endcode
    use argument objects in conjunction with \ref ArgumentObjectFactories :
    \code
    namespace vigra {
        template <class SrcIterator, class Shape, class SrcAccessor,
                  class DestIterator, class DestAccessor,
                  class Kernel = BSpline<3, double> >
        void
        resizeMultiArraySplineInterpolation(
                              triple<SrcIterator, Shape, SrcAccessor> src,
                              triple<DestIterator, Shape, DestAccessor> dest,
                              Kernel const & spline = BSpline<3, double>());
    }
    \endcode
    \deprecatedEnd

    The function implements separable spline interpolation algorithm described in

    M. Unser, A. Aldroubi, M. Eden, <i>"B-Spline Signal Processing"</i>
    IEEE Transactions on Signal Processing, vol. 41, no. 2, pp. 821-833 (part I),
    pp. 834-848 (part II), 1993.

    to obtain optimal interpolation quality and speed. You may pass the function
    a spline of arbitrary order (e.g. <TT>BSpline<ORDER, double></tt> or
    <TT>CatmullRomSpline<double></tt>). The default is a third order spline
    which gives a twice continuously differentiable interpolant.
    The implementation ensures that image values are interpolated rather
    than smoothed by first calling a recursive (sharpening) prefilter as
    described in the above paper. Then the actual interpolation is done
    using \ref resamplingConvolveLine().

    The range of both the input and output images (resp. regions)
    must be given. The input image must have a size of at
    least 4x4, the destination of at least 2x2. The scaling factors are then calculated
    accordingly. If the source image is larger than the destination, it
    is smoothed (band limited) using a recursive
    exponential filter. The source value_type (SrcAccessor::value_type) must
    be a linear algebra, i.e. it must support addition, subtraction,
    and multiplication (+, -, *), multiplication with a scalar
    real number and \ref NumericTraits "NumericTraits".
    The function uses accessors.

    <b> Usage:</b>

    <b>\#include</b> <vigra/multi_resize.hxx><br>
    Namespace: vigra

    \code
    MultiArray<3, float> src(Shape3(5, 7, 10)),
                         dest(Shape3(9, 13, 19)); // double the size

    // use default cubic spline interpolator
    resizeMultiArraySplineInterpolation(src, dest);

    // use linear interpolator
    resizeMultiArraySplineInterpolation(src, dest, BSpline<1, double>());
    \endcode

    \deprecatedUsage{resizeMultiArraySplineInterpolation}
    \code
    vigra::MultiArray<3, float> src(Shape3(5, 7, 10)),
                                dest(Shape3(9, 13, 19)); // double the size

    // use linear interpolator
    vigra::resizeMultiArraySplineInterpolation(srcMultiArrayRange(src),
               destMultiArrayRange(dest), BSpline<1, double>());

    // use default cubic spline interpolator
    vigra::resizeMultiArraySplineInterpolation(
               srcMultiArrayRange(src),
               destMultiArrayRange(dest));

    \endcode
    <b> Required Interface:</b>
    The source and destination iterators must be compatible with \ref vigra::MultiIterator. The array value
    types must be models of \ref LinearSpace.
    \deprecatedEnd
*/
doxygen_overloaded_function(template <...> void resizeMultiArraySplineInterpolation)

template <class SrcIterator, class Shape, class SrcAccessor,
          class DestIterator, class DestAccessor,
          class Kernel>
void
resizeMultiArraySplineInterpolation(
                      SrcIterator si, Shape const & sshape, SrcAccessor src,
                      DestIterator di, Shape const & dshape, DestAccessor dest,
                      Kernel const & spline)
{
    enum { N = 1 + SrcIterator::level };
    typedef typename NumericTraits<typename DestAccessor::value_type>::RealPromote TmpType;
    typedef typename AccessorTraits<TmpType>::default_accessor TmpAccessor;

    if(N==1)
    {
        detail::internalResizeMultiArrayOneDimension(si, sshape, src,
                      di, dshape, dest, spline, 0);
    }
    else
    {
        unsigned int d = 0;
        Shape tmpShape(sshape);
        tmpShape[d] = dshape[d];
        MultiArray<N, TmpType> tmp(tmpShape);
        TmpAccessor ta;

        detail::internalResizeMultiArrayOneDimension(si, sshape, src,
                             tmp.traverser_begin(), tmpShape, ta, spline, d);
        d = 1;
        for(; d<N-1; ++d)
        {
            tmpShape[d] = dshape[d];
            MultiArray<N, TmpType> dtmp(tmpShape);

            detail::internalResizeMultiArrayOneDimension(tmp.traverser_begin(), tmp.shape(), ta,
                                  dtmp.traverser_begin(), tmpShape, ta, spline, d);
            dtmp.swap(tmp);
        }
        detail::internalResizeMultiArrayOneDimension(tmp.traverser_begin(), tmp.shape(), ta,
                                        di, dshape, dest, spline, d);
    }
}

template <class SrcIterator, class Shape, class SrcAccessor,
          class DestIterator, class DestAccessor>
inline void
resizeMultiArraySplineInterpolation(
                      SrcIterator si, Shape const & sshape, SrcAccessor src,
                      DestIterator di, Shape const & dshape, DestAccessor dest)
{
    resizeMultiArraySplineInterpolation(si, sshape, src, di, dshape, dest, BSpline<3, double>());
}

template <class SrcIterator, class Shape, class SrcAccessor,
          class DestIterator, class DestAccessor,
          class Kernel>
inline void
resizeMultiArraySplineInterpolation(triple<SrcIterator, Shape, SrcAccessor> src,
                                    triple<DestIterator, Shape, DestAccessor> dest,
                                    Kernel const & spline)
{
    resizeMultiArraySplineInterpolation(src.first, src.second, src.third,
                                        dest.first, dest.second, dest.third, spline);
}

template <class SrcIterator, class Shape, class SrcAccessor,
          class DestIterator, class DestAccessor>
inline void
resizeMultiArraySplineInterpolation(triple<SrcIterator, Shape, SrcAccessor> src,
                                    triple<DestIterator, Shape, DestAccessor> dest)
{
    resizeMultiArraySplineInterpolation(src.first, src.second, src.third,
                                        dest.first, dest.second, dest.third);
}

template <unsigned int N, class T1, class S1,
                          class T2, class S2,
          class Kernel>
inline void
resizeMultiArraySplineInterpolation(MultiArrayView<N, T1, S1> const & source,
                                    MultiArrayView<N, T2, S2> dest,
                                    Kernel const & spline)
{
    resizeMultiArraySplineInterpolation(srcMultiArrayRange(source),
                                        destMultiArrayRange(dest), spline);
}

template <unsigned int N, class T1, class S1,
                          class T2, class S2>
inline void
resizeMultiArraySplineInterpolation(MultiArrayView<N, T1, S1>  const & source,
                                    MultiArrayView<N, T2, S2> dest)
{
    resizeMultiArraySplineInterpolation(srcMultiArrayRange(source),
                                        destMultiArrayRange(dest));
}

//@}

} // namespace vigra

#endif // VIGRA_MULTI_RESIZE_HXX