lsstGil.h

Go to the documentation of this file.

/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 * 
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the LSST License Statement and 
 * the GNU General Public License along with this program.  If not, 
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */
 
#if !defined(GIL_LSST_H)
#define GIL_LSST_H 1
/*
 * Extend the gil types to provide non-scaling float/int32 images, type bits32[fs]_noscale
 */
#include "boost/mpl/assert.hpp"
#include "boost/mpl/bool.hpp"
#include "boost/mpl/if.hpp"
#include "boost/type_traits/is_same.hpp"

//#define BOOST_GIL_USE_CONCEPT_CHECK 1

#if defined(__ICC)
#pragma warning (push)
#pragma warning (disable: 68)
#pragma warning (disable: 304)
#endif

#include "boost/gil/gil_all.hpp"

#if defined(__ICC)
#pragma warning (pop)
#endif

namespace lsst { namespace afw { namespace image {

// 
// We want to be able to call operator+= in the global namespace, but define it in lsst::afw::image.
// To make this possible, at least one of its arguments must be in lsst::afw::image, so we define
// this type to make the argument lookup ("Koenig Lookup") work smoothly
//
struct pair2I : public std::pair<int, int> {
    explicit pair2I(int first, int second) : std::pair<int, int>(first, second) {}
    pair2I(std::pair<int, int> pair) : std::pair<int, int>(pair) {}
};

template <typename T>
boost::gil::memory_based_2d_locator<T>& operator+=(boost::gil::memory_based_2d_locator<T> &loc, pair2I off) {
    return (loc += boost::gil::point2<std::ptrdiff_t>(off.first, off.second));
}
template <typename T>
boost::gil::memory_based_2d_locator<T>& operator-=(boost::gil::memory_based_2d_locator<T> &loc, pair2I off) {
    return (loc -= boost::gil::point2<std::ptrdiff_t>(off.first, off.second));
}

}}} // namespace lsst::afw::image

template <typename T>
boost::gil::memory_based_2d_locator<T>& operator+=(boost::gil::memory_based_2d_locator<T> &loc,
                                                   std::pair<int, int> off) {
    return (loc += boost::gil::point2<std::ptrdiff_t>(off.first, off.second));
}
template <typename T>
boost::gil::memory_based_2d_locator<T>& operator-=(boost::gil::memory_based_2d_locator<T> &loc,
                                                   std::pair<int, int> off) {
    return (loc -= boost::gil::point2<std::ptrdiff_t>(off.first, off.second));
}

namespace boost { namespace gil {
/*
 * Define types that are pure (un)signed long, without scaling into [0, 1]
 */
typedef uint64_t bits64;
typedef int64_t bits64s;

GIL_DEFINE_BASE_TYPEDEFS(64, gray)
GIL_DEFINE_ALL_TYPEDEFS_INTERNAL(64, dev2n, devicen_t<2>, devicen_layout_t<2>)
GIL_DEFINE_BASE_TYPEDEFS(64s, gray)
GIL_DEFINE_ALL_TYPEDEFS_INTERNAL(64s, dev2n, devicen_t<2>, devicen_layout_t<2>)
            
/*
 * Define a type that's a pure float, without scaling into [0, 1]
 */
typedef float bits32f_noscale;

GIL_DEFINE_BASE_TYPEDEFS(32f_noscale, gray)
GIL_DEFINE_ALL_TYPEDEFS_INTERNAL(32f_noscale, dev2n, devicen_t<2>, devicen_layout_t<2>)

template<> struct channel_multiplier<bits32f_noscale> : public std::binary_function<bits32f_noscale,bits32f_noscale,bits32f_noscale> {
    bits32f_noscale operator()(bits32f_noscale a, bits32f_noscale b) const { return a*b; }
};
            
/*
 * Define a type that's a pure double, without scaling into [0, 1]
 */
typedef double bits64f_noscale;

GIL_DEFINE_BASE_TYPEDEFS(64f_noscale, gray)
GIL_DEFINE_ALL_TYPEDEFS_INTERNAL(64f_noscale, dev2n, devicen_t<2>, devicen_layout_t<2>)

/************************************************************************************************************/
//
// Conversions that don't scale
//
template <typename DstChannelV>
struct channel_converter<bits32f_noscale, DstChannelV> :
        public std::unary_function<bits32f_noscale,DstChannelV> {
    DstChannelV   operator()(bits32f_noscale x) const { return DstChannelV(x + 0.5f); }
};

template <typename SrcChannelV>
struct channel_converter<SrcChannelV,bits32f_noscale> :
        public std::unary_function<SrcChannelV,bits32f_noscale> {
    bits32f_noscale operator()(SrcChannelV   x) const { return bits32f_noscale(x); }
};

template <typename DstChannelV>
struct channel_converter<bits64f_noscale, DstChannelV> :
        public std::unary_function<bits64f_noscale,DstChannelV> {
    DstChannelV   operator()(bits64f_noscale x) const { return DstChannelV(x + 0.5f); }
};

template <typename SrcChannelV>
struct channel_converter<SrcChannelV,bits64f_noscale> :
        public std::unary_function<SrcChannelV,bits64f_noscale> {
    bits64f_noscale operator()(SrcChannelV   x) const { return bits64f_noscale(x); }
};

//
// Totally specialised templates to resolve ambiguities
//
#define LSST_CONVERT_NOOP(T1, T2) \
template <> \
struct channel_converter<T1, T2> : public std::unary_function<T1, T2> { \
    T2 operator()(T1 x) const { return static_cast<T2>(x); } \
}; \
\
template <> \
struct channel_converter<T2, T1> : public std::unary_function<T2, T1> { \
    T1 operator()(T2 x) const { return static_cast<T1>(x); }            \
}

LSST_CONVERT_NOOP(bits32f_noscale, bits64f_noscale);

LSST_CONVERT_NOOP(unsigned char,  short);
LSST_CONVERT_NOOP(unsigned char,  unsigned short);
LSST_CONVERT_NOOP(unsigned char,  int);
LSST_CONVERT_NOOP(unsigned short, short);
LSST_CONVERT_NOOP(unsigned short, int);
LSST_CONVERT_NOOP(short, int);

#undef LSST_CONVERT_NOOP

/************************************************************************************************************/
//
// These are in the boost::gil namespace in order to permit Koenig lookup
//
#define LSST_BOOST_GIL_OP_EQUALS(TYPE, OP) \
template<typename T2> \
TYPE##_pixel_t& operator OP##=(TYPE##_pixel_t& lhs, T2 rhs) { return (lhs = lhs OP rhs); }

#define LSST_BOOST_GIL_OP_EQUALS_ALL(PIXTYPE) \
    LSST_BOOST_GIL_OP_EQUALS(PIXTYPE, +) \
    LSST_BOOST_GIL_OP_EQUALS(PIXTYPE, -) \
    LSST_BOOST_GIL_OP_EQUALS(PIXTYPE, *) \
    LSST_BOOST_GIL_OP_EQUALS(PIXTYPE, /) \
    LSST_BOOST_GIL_OP_EQUALS(PIXTYPE, &) \
    LSST_BOOST_GIL_OP_EQUALS(PIXTYPE, |)

LSST_BOOST_GIL_OP_EQUALS_ALL(gray8)
LSST_BOOST_GIL_OP_EQUALS_ALL(gray8s)
LSST_BOOST_GIL_OP_EQUALS_ALL(gray16)
LSST_BOOST_GIL_OP_EQUALS_ALL(gray16s)
LSST_BOOST_GIL_OP_EQUALS_ALL(gray32)
LSST_BOOST_GIL_OP_EQUALS_ALL(gray32s)
LSST_BOOST_GIL_OP_EQUALS_ALL(gray32f_noscale)
LSST_BOOST_GIL_OP_EQUALS_ALL(gray64)
LSST_BOOST_GIL_OP_EQUALS_ALL(gray64s)
LSST_BOOST_GIL_OP_EQUALS_ALL(gray64f_noscale)

#undef LSST_BOOST_GIL_OP_EQUALS
#undef LSST_BOOST_GIL_OP_EQUALS_ALL

} }  // namespace boost::gil


/************************************************************************************************************/

namespace lsst { namespace afw { namespace image { namespace detail {
    //
    // Map typenames to gil's types
    //
#if defined(__ICC)
#pragma warning (push)
#pragma warning (disable: 304)
#endif

    template<typename T, bool rescale=false> struct types_traits {
        BOOST_MPL_ASSERT_MSG(boost::mpl::bool_<false>::value,
                             I_DO_NOT_KNOW_HOW_TO_MAP_THIS_TYPE_TO_A_GIL_TYPE,
                             ()
                            );
    };
#if defined(__ICC)
#pragma warning (pop)
#endif
                
    template<> struct types_traits<unsigned char, false> {
        typedef boost::gil::gray8_image_t image_t;
        typedef boost::gil::gray8_view_t view_t;
        typedef boost::gil::gray8c_view_t const_view_t;
        typedef boost::gil::channel_traits<char>::reference reference;
        typedef boost::gil::channel_traits<char>::const_reference const_reference;
    };

    template<> struct types_traits<short, false> {
        typedef boost::gil::gray16s_image_t image_t;
        typedef boost::gil::gray16s_view_t view_t;
        typedef boost::gil::gray16sc_view_t const_view_t;
        typedef boost::gil::channel_traits<short>::reference reference;
        typedef boost::gil::channel_traits<short>::const_reference const_reference;
    };

    template<> struct types_traits<unsigned short, false> {
        typedef boost::gil::gray16_image_t image_t;
        typedef boost::gil::gray16_view_t view_t;
        typedef boost::gil::gray16c_view_t const_view_t;
        typedef boost::gil::channel_traits<unsigned short>::reference reference;
        typedef boost::gil::channel_traits<unsigned short>::const_reference const_reference;
    };

    template<> struct types_traits<int, false> {
        typedef boost::gil::gray32s_image_t image_t;
        typedef boost::gil::gray32s_view_t view_t;
        typedef boost::gil::gray32sc_view_t const_view_t;
        typedef boost::gil::channel_traits<int>::reference reference;
        typedef boost::gil::channel_traits<int>::const_reference const_reference;
    };

    template<> struct types_traits<unsigned int, false> {
        typedef boost::gil::gray32_image_t image_t;
        typedef boost::gil::gray32_view_t view_t;
        typedef boost::gil::gray32c_view_t const_view_t;
        typedef boost::gil::channel_traits<int>::reference reference;
        typedef boost::gil::channel_traits<int>::const_reference const_reference;
    };

    template<> struct types_traits<float, false> {
        typedef boost::gil::gray32f_noscale_image_t image_t;
        typedef boost::gil::gray32f_noscale_view_t view_t;
        typedef boost::gil::gray32f_noscalec_view_t const_view_t;
        typedef boost::gil::channel_traits<float>::reference reference;
        typedef boost::gil::channel_traits<float>::const_reference const_reference;
    };

    template<> struct types_traits<long, false> {
        typedef boost::gil::gray64s_image_t image_t;
        typedef boost::gil::gray64s_view_t view_t;
        typedef boost::gil::gray64sc_view_t const_view_t;
        typedef boost::gil::channel_traits<long>::reference reference;
        typedef boost::gil::channel_traits<long>::const_reference const_reference;
    };

    template<> struct types_traits<unsigned long, false> {
        typedef boost::gil::gray64_image_t image_t;
        typedef boost::gil::gray64_view_t view_t;
        typedef boost::gil::gray64c_view_t const_view_t;
        typedef boost::gil::channel_traits<long>::reference reference;
        typedef boost::gil::channel_traits<long>::const_reference const_reference;
    };

    namespace {
        struct unknown {};                  // two unused and unimplemented types
        struct unknown_u {};
        /*
         * Return long long type (as type) if it's a synonym for boost::int64_t
         * We also need unsigned long long (as type_u), because "unsigned unknown" won't compile
         */ 
        struct CheckBoost64 {
            typedef boost::mpl::if_<boost::is_same<long long, boost::int64_t>,
                                    long long, struct unknown>::type type;
            typedef boost::mpl::if_<boost::is_same<long long, boost::int64_t>,
                                    unsigned long long, struct unknown_u>::type type_u;
        };
    }

    template<> struct types_traits<CheckBoost64::type, false> {
        typedef boost::gil::gray64s_image_t image_t;
        typedef boost::gil::gray64s_view_t view_t;
        typedef boost::gil::gray64sc_view_t const_view_t;
        typedef boost::gil::channel_traits<long>::reference reference;
        typedef boost::gil::channel_traits<long>::const_reference const_reference;
    };

    template<> struct types_traits<CheckBoost64::type_u, false> {
        typedef boost::gil::gray64_image_t image_t;
        typedef boost::gil::gray64_view_t view_t;
        typedef boost::gil::gray64c_view_t const_view_t;
        typedef boost::gil::channel_traits<long>::reference reference;
        typedef boost::gil::channel_traits<long>::const_reference const_reference;
    };

    template<> struct types_traits<double, false> {
        typedef boost::gil::gray64f_noscale_image_t image_t;
        typedef boost::gil::gray64f_noscale_view_t view_t;
        typedef boost::gil::gray64f_noscalec_view_t const_view_t;
        typedef boost::gil::channel_traits<double>::reference reference;
        typedef boost::gil::channel_traits<double>::const_reference const_reference;
    };

    template<typename T>
    struct const_iterator_type {
        typedef typename boost::gil::const_iterator_type<T>::type type;
    };

    template<typename T>
    struct const_locator_type {         // should assert that T is a locator
        typedef typename T::const_t type;
    };

    typedef boost::gil::point2<std::ptrdiff_t> difference_type; // type used to advance locators
}}}}    // namespace lsst::afw::image::detail

namespace boost { namespace gil {

template <typename View1, typename View2, typename View3, typename ViewDest, typename F> GIL_FORCEINLINE 
F transform_pixels(const View1& src1, const View2& src2,const View3& src3,const ViewDest& dst, F fun) {
    for (std::ptrdiff_t y=0; y<dst.height(); ++y) {
        typename View1::x_iterator srcIt1=src1.row_begin(y);
        typename View2::x_iterator srcIt2=src2.row_begin(y);
        typename View3::x_iterator srcIt3=src3.row_begin(y);
        typename ViewDest::x_iterator dstIt=dst.row_begin(y);
        for (std::ptrdiff_t x=0; x<dst.width(); ++x)
            dstIt[x]=fun(srcIt1[x],srcIt2[x],srcIt3[x]);
    }
    return fun;
}

template <typename View1, typename View2, typename View3, typename View4, typename ViewDest, typename F> GIL_FORCEINLINE 
F transform_pixels(const View1& src1, const View2& src2,const View3& src3,const View4& src4,const ViewDest& dst, F fun) {
    for (std::ptrdiff_t y=0; y<dst.height(); ++y) {
        typename View1::x_iterator srcIt1=src1.row_begin(y);
        typename View2::x_iterator srcIt2=src2.row_begin(y);
        typename View3::x_iterator srcIt3=src3.row_begin(y);
        typename View4::x_iterator srcIt4=src4.row_begin(y);
        typename ViewDest::x_iterator dstIt=dst.row_begin(y);
        for (std::ptrdiff_t x=0; x<dst.width(); ++x)
            dstIt[x]=fun(srcIt1[x],srcIt2[x],srcIt3[x],srcIt4[x]);
    }
    return fun;
}
}}                                  // namespace boost::gil
#endif