ArraySamplers2.h

Go to the documentation of this file.

/*************************************************************************
> File Name: ArraySamplers2.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 2-D nearest array sampler class.
> Created Time: 2017/04/29
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_ARRAY_SAMPLERS2_H
#define CUBBYFLOW_ARRAY_SAMPLERS2_H

#include <Core/Array/ArrayAccessor2.h>
#include <Core/Array/ArraySamplers.h>
#include <Core/Vector/Vector2.h>

#include <functional>

namespace CubbyFlow
{
    template <typename T, typename R>
    class NearestArraySampler<T, R, 2> final
    {
    public:
        static_assert(std::is_floating_point<R>::value, "Samplers only can be instantiated with floating point types");

        explicit NearestArraySampler(
            const ConstArrayAccessor2<T>& accessor,
            const Vector2<R>& gridSpacing,
            const Vector2<R>& gridOrigin);

        NearestArraySampler(const NearestArraySampler& other);

        T operator()(const Vector2<R>& pt) const;

        void GetCoordinate(const Vector2<R>& pt, Point2UI* index) const;

        std::function<T(const Vector2<R>&)> Functor() const;

    private:
        Vector2<R> m_gridSpacing;
        Vector2<R> m_origin;
        ConstArrayAccessor2<T> m_accessor;
    };

    template <typename T, typename R>
    using NearestArraySampler2 = NearestArraySampler<T, R, 2>;

    template <typename T, typename R>
    class LinearArraySampler<T, R, 2> final
    {
    public:
        static_assert(std::is_floating_point<R>::value, "Samplers only can be instantiated with floating point types");

        explicit LinearArraySampler(
            const ConstArrayAccessor2<T>& accessor,
            const Vector2<R>& gridSpacing,
            const Vector2<R>& gridOrigin);

        LinearArraySampler(const LinearArraySampler& other);

        T operator()(const Vector2<R>& pt) const;

        void GetCoordinatesAndWeights(
            const Vector2<R>& pt,
            std::array<Point2UI, 4>* indices,
            std::array<R, 4>* weights) const;

        void GetCoordinatesAndGradientWeights(
            const Vector2<R>& pt,
            std::array<Point2UI, 4>* indices,
            std::array<Vector2<R>, 4>* weights) const;

        std::function<T(const Vector2<R>&)> Functor() const;

    private:
        Vector2<R> m_gridSpacing;
        Vector2<R> m_invGridSpacing;
        Vector2<R> m_origin;
        ConstArrayAccessor2<T> m_accessor;
    };

    template <typename T, typename R>
    using LinearArraySampler2 = LinearArraySampler<T, R, 2>;

    template <typename T, typename R>
    class CubicArraySampler<T, R, 2> final
    {
    public:
        static_assert(std::is_floating_point<R>::value, "Samplers only can be instantiated with floating point types");

        explicit CubicArraySampler(
            const ConstArrayAccessor2<T>& accessor,
            const Vector2<R>& gridSpacing,
            const Vector2<R>& gridOrigin);

        CubicArraySampler(const CubicArraySampler& other);

        T operator()(const Vector2<R>& pt) const;

        std::function<T(const Vector2<R>&)> Functor() const;

    private:
        Vector2<R> m_gridSpacing;
        Vector2<R> m_origin;
        ConstArrayAccessor2<T> m_accessor;
    };

    template <typename T, typename R>
    using CubicArraySampler2 = CubicArraySampler<T, R, 2>;
}

#include <Core/Array/ArraySamplers2-Impl.h>

#endif