dlib C++ Library - equalize_histogram_abstract.h

    // Copyright (C) 2006  Davis E. King (davis@dlib.net)
    // License: Boost Software License   See LICENSE.txt for the full license.
    #undef DLIB_EQUALIZE_HISTOGRAm_ABSTRACT_
    #ifdef DLIB_EQUALIZE_HISTOGRAm_ABSTRACT_

    #include "../pixel.h"
    #include "../matrix.h"
    #include "../image_processing/generic_image.h"

    namespace dlib
    {

    // ---------------------------------------------------------------------------------------

        template <
            typename in_image_type,
            typename out_image_type
            >
        void equalize_histogram (
            const in_image_type& in_img,
            out_image_type& out_img
        );
        /*!
            requires
                - in_image_type == an image object that implements the interface defined in
                  dlib/image_processing/generic_image.h
                - out_image_type == an image object that implements the interface defined in
                  dlib/image_processing/generic_image.h
                - Let pixel_type be the type of pixel in either input or output images, then we
                  must have:
                    - pixel_traits<pixel_type>::has_alpha == false
                    - pixel_traits<pixel_type>::is_unsigned == true
                - For the input image pixel type, we have the additional requirement that:
                    - pixel_traits<pixel_type>::max() <= 65535
            ensures
                - #out_img == the histogram equalized version of in_img
                - #out_img.nc() == in_img.nc()
                - #out_img.nr() == in_img.nr()
        !*/

        template <
            typename image_type
            >
        void equalize_histogram (
            image_type& img
        );
        /*!
            requires
                - it is valid to call equalize_histogram(img,img)
            ensures
                - calls equalize_histogram(img,img);
        !*/

    // ---------------------------------------------------------------------------------------

        template <
            typename in_image_type,
            long R,
            long C,
            typename MM
            >
        void get_histogram (
            const in_image_type& in_img,
            matrix<unsigned long,R,C,MM>& hist
        );
        /*!
            requires
                - in_image_type == an image object that implements the interface defined in
                  dlib/image_processing/generic_image.h
                - Let pixel_type denote the type of pixel in in_img, then we must have:
                    - pixel_traits<pixel_type>::is_unsigned == true
                    - pixel_traits<pixel_type>::max() <= 65535
                - hist must be capable of representing a column or row vector of length
                  pixel_traits<typename in_image_type>::max(). I.e. if R and C are nonzero
                  then they must be values that don't conflict with the previous sentence.
            ensures
                - #hist.size() == pixel_traits<typename in_image_type>::max()
                - #hist.nc() == 1 || #hist.nr() == 1 (i.e. hist is either a row or column vector)
                - #hist == the histogram for in_img.  I.e. it is the case that for all
                  valid i:
                    - hist(i) == the number of times a pixel with intensity i appears
                      in in_img
        !*/

    // ----------------------------------------------------------------------------------------

        template <
            typename in_image_type,
            long R,
            long C,
            typename MM
            >
        void get_histogram (
            const in_image_type& in_img,
            matrix<unsigned long,R,C,MM>& hist,
            size_t hist_size
        );
        /*!
            requires
                - in_image_type == an image object that implements the interface defined in
                  dlib/image_processing/generic_image.h
                - Let pixel_type denote the type of pixel in in_img, then we must have:
                    - pixel_traits<pixel_type>::is_unsigned == true
                - hist must be capable of representing a column or row vector of length
                  hist_size. I.e. if R and C are nonzero then they must be values that don't
                  conflict with the previous sentence.
            ensures
                - #hist.size() == hist_size
                - #hist.nc() == 1 || #hist.nr() == 1 (i.e. hist is either a row or column vector)
                - #hist == the histogram for in_img, except pixel values >= hist_size are
                  ignored.  I.e. it is the case that for all valid i:
                    - hist(i) == the number of times a pixel with intensity i appears
                      in in_img
        !*/

    // ---------------------------------------------------------------------------------------

    }

    #endif // DLIB_EQUALIZE_HISTOGRAm_ABSTRACT_