ArraySamplers3.h

Go to the documentation of this file.

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

#include <Core/Array/ArrayAccessor3.h>
#include <Core/Array/ArraySamplers.h>
#include <Core/Vector/Vector3.h>

#include <functional>

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

        explicit NearestArraySampler(
            const ConstArrayAccessor3<T>& accessor,
            const Vector3<R>& gridSpacing,
            const Vector3<R>& gridOrigin);

        NearestArraySampler(const NearestArraySampler& other);

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

        void GetCoordinate(const Vector3<R>& pt, Point3UI* index) const;

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

    private:
        Vector3<R> m_gridSpacing;
        Vector3<R> m_origin;
        ConstArrayAccessor3<T> m_accessor;
    };

    template <typename T, typename R>
    using NearestArraySampler3 = NearestArraySampler<T, R, 3>;

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

        explicit LinearArraySampler(
            const ConstArrayAccessor3<T>& accessor,
            const Vector3<R>& gridSpacing,
            const Vector3<R>& gridOrigin);

        LinearArraySampler(const LinearArraySampler& other);

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

        void GetCoordinatesAndWeights(
            const Vector3<R>& pt,
            std::array<Point3UI, 8>* indices,
            std::array<R, 8>* weights) const;

        void GetCoordinatesAndGradientWeights(
            const Vector3<R>& pt,
            std::array<Point3UI, 8>* indices,
            std::array<Vector3<R>, 8>* weights) const;

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

    private:
        Vector3<R> m_gridSpacing;
        Vector3<R> m_invGridSpacing;
        Vector3<R> m_origin;
        ConstArrayAccessor3<T> m_accessor;
    };

    template <typename T, typename R>
    using LinearArraySampler3 = LinearArraySampler<T, R, 3>;

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

        explicit CubicArraySampler(
            const ConstArrayAccessor3<T>& accessor,
            const Vector3<R>& gridSpacing,
            const Vector3<R>& gridOrigin);

        CubicArraySampler(const CubicArraySampler& other);

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

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

    private:
        Vector3<R> m_gridSpacing;
        Vector3<R> m_origin;
        ConstArrayAccessor3<T> m_accessor;
    };

    template <typename T, typename R>
    using CubicArraySampler3 = CubicArraySampler<T, R, 3>;
}

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

#endif