CImage_unittest.cpp

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          https://www.mrpt.org/                         |
   |                                                                        |
   | Copyright (c) 2005-2020, Individual contributors, see AUTHORS file     |
   | See: https://www.mrpt.org/Authors - All rights reserved.               |
   | Released under BSD License. See: https://www.mrpt.org/License          |
   +------------------------------------------------------------------------+ */

#include <CTraitsTest.h>
#include <gtest/gtest.h>
#include <mrpt/img/CImage.h>
#include <mrpt/img/TColor.h>
#include <mrpt/io/CMemoryStream.h>
#include <mrpt/math/CMatrixDynamic.h>
#include <mrpt/random.h>
#include <mrpt/serialization/CArchive.h>
#include <mrpt/system/filesystem.h>
#include <mrpt/system/memory.h>
#include <test_mrpt_common.h>

// Universal include for all versions of OpenCV
#include <mrpt/3rdparty/do_opencv_includes.h>

template class mrpt::CTraitsTest<mrpt::img::CImage>;

using namespace std::string_literals;
const auto tstImgFileColor =
    mrpt::UNITTEST_BASEDIR + "/samples/img_basic_example/frame_color.jpg"s;

// Generate random img:
static void fillImagePseudoRandom(uint32_t seed, mrpt::img::CImage& img)
{
    mrpt::random::Randomize(seed);
    auto& rnd = mrpt::random::getRandomGenerator();

    for (unsigned y = 0; y < img.getHeight(); y++)
    {
        for (unsigned x = 0; x < img.getWidth(); x++)
        {
            const uint8_t c = static_cast<uint8_t>(rnd.drawUniform32bit());
            img.at<uint8_t>(x, y) = c;
        }
    }
}

// Expect images to be identical:
static bool expect_identical(
    const mrpt::img::CImage& a, const mrpt::img::CImage& b,
    const std::string& s = std::string())
{
    EXPECT_EQ(a.getWidth(), b.getWidth());
    EXPECT_EQ(a.getHeight(), b.getHeight());
    for (unsigned int y = 0; y < a.getHeight(); y++)
        for (unsigned int x = 0; x < a.getWidth(); x++)
        {
            EXPECT_EQ(a.at<uint8_t>(x, y), b.at<uint8_t>(x, y)) << s;
            if (a.at<uint8_t>(x, y) != b.at<uint8_t>(x, y)) return false;
        }
    return true;
}

TEST(CImage, CtorDefault)
{
    mrpt::img::CImage img;
    EXPECT_THROW(img.isColor(), std::exception);
}

#if MRPT_HAS_OPENCV

static void CtorSized_gray(unsigned int w, unsigned int h)
{
    using namespace mrpt::img;
    CImage img(w, h, CH_GRAY);
    EXPECT_EQ(img.getWidth(), w);
    EXPECT_EQ(img.getHeight(), 48U);
    EXPECT_EQ(img.getChannelCount(), 1U);
    EXPECT_EQ(img.getPixelDepth(), PixelDepth::D8U);
    EXPECT_FALSE(img.isColor());
}

TEST(CImage, CtorSized)
{
    using namespace mrpt::img;
    {
        CImage img(64, 48, CH_RGB);
        EXPECT_EQ(img.getWidth(), 64U);
        EXPECT_EQ(img.getHeight(), 48U);
        EXPECT_EQ(img.getChannelCount(), 3U);
        EXPECT_EQ(img.getPixelDepth(), PixelDepth::D8U);
        EXPECT_TRUE(img.isColor());
    }
    for (unsigned w = 64; w < 70; w++)
    {
        CtorSized_gray(w, 48);
    }
}

TEST(CImage, GetSetPixel)
{
    using namespace mrpt::img;
    CImage img(20, 10, CH_GRAY);
    img.setPixel(10, 2, TColor(0x80, 0x80, 0x80));
    EXPECT_EQ(img.at<uint8_t>(10, 2), 0x80);
    EXPECT_EQ(*img(10, 2), 0x80);

    img.setPixel(11, 2, TColor(0x0, 0x0, 0x0));
    EXPECT_EQ(img.at<uint8_t>(11, 2), 0x00);

    img.setPixel(12, 2, TColor(0xff, 0xff, 0xff));
    EXPECT_EQ(img.at<uint8_t>(12, 2), 0xff);

    img.at<uint8_t>(13, 2) = 0x70;
    EXPECT_EQ(img.at<uint8_t>(13, 2), 0x70);

    auto* line = img.ptrLine<uint8_t>(5);
    for (uint8_t i = 0; i < 20; i++)
    {
        line[i] = i;
        EXPECT_EQ(img.at<uint8_t>(i, 5), i);
    }

    mrpt::math::CMatrixFloat M;
    img.getAsMatrix(M, true, 0, 0, -1, -1, false /* dont normalize (0,1) */);
    for (uint8_t i = 0; i < 20; i++)
    {
        EXPECT_NEAR(static_cast<double>(M(5, i)), i, 1e-8);
    }
}

TEST(CImage, CopyMoveSwap)
{
    using namespace mrpt::img;
    {
        CImage a(20, 10, CH_GRAY);
        a.at<uint8_t>(1, 2) = 0x80;
        // Shallow copy:
        CImage b = a;
        EXPECT_EQ(b.at<uint8_t>(1, 2), 0x80);

        a.at<uint8_t>(1, 3) = 0x81;
        EXPECT_EQ(b.at<uint8_t>(1, 3), 0x81);

        // Deep copy:
        CImage c = a.makeDeepCopy();
        EXPECT_EQ(c.at<uint8_t>(1, 2), 0x80);

        c.at<uint8_t>(1, 3) = 0x0;
        a.at<uint8_t>(1, 3) = 0x81;
        EXPECT_NE(c.at<uint8_t>(1, 3), 0x81);
    }

    {
        CImage a(20, 10, CH_GRAY);
        a.at<uint8_t>(1, 2) = 0x80;
        // Shallow copy ctor:
        CImage b(a, mrpt::img::SHALLOW_COPY);
        EXPECT_EQ(b.at<uint8_t>(1, 2), 0x80);

        a.at<uint8_t>(1, 3) = 0x81;
        EXPECT_EQ(b.at<uint8_t>(1, 3), 0x81);

        // Deep copy ctor:
        CImage c(a, mrpt::img::DEEP_COPY);
        EXPECT_EQ(c.at<uint8_t>(1, 2), 0x80);

        c.at<uint8_t>(1, 3) = 0x0;
        a.at<uint8_t>(1, 3) = 0x81;
        EXPECT_NE(c.at<uint8_t>(1, 3), 0x81);
    }

    {
        CImage a(20, 10, CH_GRAY);
        a.at<uint8_t>(1, 2) = 0x80;
        // Deep copy:
        CImage b = a.makeDeepCopy();
        EXPECT_EQ(b.at<uint8_t>(1, 2), 0x80);

        a.clear();
        a.resize(30, 30, CH_RGB);
        b.at<uint8_t>(1, 3) = 0x0;
        a.at<uint8_t>(1, 3) = 0x81;
        EXPECT_NE(b.at<uint8_t>(1, 3), 0x81);
    }

    {
        CImage a(20, 10, CH_GRAY);
        a.at<uint8_t>(1, 2) = 0x80;
        // move:
        CImage b = std::move(a);
        EXPECT_EQ(b.getWidth(), 20U);
        EXPECT_EQ(b.getHeight(), 10U);
        EXPECT_EQ(b.at<uint8_t>(1, 2), 0x80);
    }

    {
        CImage a(20, 10, CH_GRAY), b;
        a.at<uint8_t>(1, 2) = 0x80;
        // swap:
        a.swap(b);
        EXPECT_EQ(b.getWidth(), 20U);
        EXPECT_EQ(b.getHeight(), 10U);
        EXPECT_EQ(b.at<uint8_t>(1, 2), 0x80);
    }
}

TEST(CImage, ExternalImage)
{
    using namespace mrpt::img;
    {
        CImage a;
        a.setExternalStorage(tstImgFileColor);
        // Test automatic load-on-the-fly:
        EXPECT_EQ(a.getWidth(), 320U);
        EXPECT_EQ(a.getHeight(), 240U);
    }

    {
        CImage a;
        a.setExternalStorage("./foo_61717181.png");
        // Test exception on not found
        EXPECT_THROW(a.getWidth(), mrpt::img::CExceptionExternalImageNotFound);
    }
}

TEST(CImage, ConvertGray)
{
    using namespace mrpt::img;
    {
        CImage a;
        bool load_ok = a.loadFromFile(tstImgFileColor);
        EXPECT_TRUE(load_ok);

        CImage b = a.grayscale();
        EXPECT_EQ(b.getWidth(), a.getWidth());
        EXPECT_EQ(b.getHeight(), a.getHeight());
        EXPECT_FALSE(b.isColor());
    }
}

TEST(CImage, CtorRefOrGray)
{
    using namespace mrpt::img;
    {
        CImage a;
        bool load_ok = a.loadFromFile(tstImgFileColor);
        EXPECT_TRUE(load_ok);

        const CImage b(a, FAST_REF_OR_CONVERT_TO_GRAY);
        EXPECT_EQ(b.getWidth(), a.getWidth());
        EXPECT_EQ(b.getHeight(), a.getHeight());
        EXPECT_FALSE(b.isColor());
    }
    {
        CImage a(20, 10, CH_GRAY);
        a.at<uint8_t>(1, 2) = 0x80;

        const CImage b(a, FAST_REF_OR_CONVERT_TO_GRAY);
        EXPECT_EQ(b.getWidth(), a.getWidth());
        EXPECT_EQ(b.getHeight(), a.getHeight());
        EXPECT_FALSE(b.isColor());
        EXPECT_EQ(b.at<uint8_t>(1, 2), 0x80);
    }
}

TEST(CImage, HalfAndDouble)
{
    using namespace mrpt::img;

    CImage a(32, 10, CH_GRAY);
    a.at<uint8_t>(0, 0) = 0x80;
    a.at<uint8_t>(0, 1) = 0x80;
    a.at<uint8_t>(1, 0) = 0x80;
    a.at<uint8_t>(1, 1) = 0x80;

    // Half:
    {
        const CImage imgH = a.scaleHalf(mrpt::img::IMG_INTERP_NN);
        EXPECT_EQ(imgH.getWidth(), a.getWidth() / 2);
        EXPECT_EQ(imgH.getHeight(), a.getHeight() / 2);
        EXPECT_EQ(imgH.isColor(), a.isColor());
        EXPECT_EQ(imgH.at<uint8_t>(0, 0), a.at<uint8_t>(0, 0));
    }
    // Double:
    {
        const CImage imgD = a.scaleDouble(mrpt::img::IMG_INTERP_NN);
        EXPECT_EQ(imgD.getWidth(), a.getWidth() * 2);
        EXPECT_EQ(imgD.getHeight(), a.getHeight() * 2);
        EXPECT_EQ(imgD.isColor(), a.isColor());
    }
}
TEST(CImage, getChannelsOrder)
{
    using namespace mrpt::img;
    {
        CImage a;
        bool load_ok = a.loadFromFile(tstImgFileColor);
        EXPECT_TRUE(load_ok);
        EXPECT_EQ(std::string("BGR"), a.getChannelsOrder());
    }
    {
        CImage a(32, 10, CH_GRAY);
        EXPECT_EQ(std::string("GRAY"), a.getChannelsOrder());
    }
}

TEST(CImage, ChangeCvMatCopies)
{
    using namespace mrpt::img;

    {
        CImage a(20, 10, CH_GRAY);
        a.at<uint8_t>(1, 2) = 0x80;
        // change shallow copy:
        cv::Mat m = a.asCvMat<cv::Mat>(SHALLOW_COPY);
        m.at<uint8_t>(2, 1) = 0x70;
        // Expect change in source:
        EXPECT_EQ(a.at<uint8_t>(1, 2), 0x70);

        // size:
        cv::Mat& m2 = a.asCvMatRef();
        cv::Mat& m3 = a.asCvMatRef();
        EXPECT_EQ(&m2, &m3);

        m2 = cv::Mat(40, 40, CV_8UC1);

        cv::Mat& m4 = a.asCvMatRef();
        EXPECT_EQ(&m2, &m4);

        EXPECT_EQ(a.getWidth(), 40U);
        EXPECT_EQ(a.getHeight(), 40U);
    }
    {
        CImage a(20, 10, CH_GRAY);
        a.at<uint8_t>(1, 2) = 0x80;
        // change deep copy:
        cv::Mat m = a.asCvMat<cv::Mat>(DEEP_COPY);
        m.at<uint8_t>(2, 1) = 0x70;
        // Expect NO change in source:
        EXPECT_EQ(a.at<uint8_t>(1, 2), 0x80);

        // size:
        m = cv::Mat(40, 40, CV_8UC1);
        EXPECT_EQ(a.getWidth(), 20U);
        EXPECT_EQ(a.getHeight(), 10U);
    }
}

TEST(CImage, ScaleImage)
{
    using namespace mrpt::img;
    CImage a;
    bool load_ok = a.loadFromFile(tstImgFileColor);
    EXPECT_TRUE(load_ok);

    {
        CImage b;
        a.scaleImage(b, 600, 400);
        EXPECT_EQ(b.getWidth(), 600U);
        EXPECT_EQ(b.getHeight(), 400U);
        EXPECT_EQ(a.getWidth(), 320U);
        EXPECT_EQ(a.getHeight(), 240U);
    }

    for (int pass = 0; pass < 2; pass++)
    {
        CImage c;
        if (pass == 0)
            c = a.makeDeepCopy();
        else
            a.scaleImage(c, 311, 211);
        const auto cw = c.getWidth(), ch = c.getHeight();

        {
            CImage b;
            c.scaleHalf(b, IMG_INTERP_NN);
            EXPECT_EQ(b.getWidth(), cw / 2);
            EXPECT_EQ(b.getHeight(), ch / 2);
            EXPECT_EQ(c.getWidth(), cw);
            EXPECT_EQ(c.getHeight(), ch);
        }
        {
            CImage ag = c.grayscale();
            CImage b;
            ag.scaleHalf(b, IMG_INTERP_LINEAR);
            EXPECT_EQ(b.getWidth(), cw / 2);
            EXPECT_EQ(b.getHeight(), ch / 2);
            EXPECT_EQ(ag.getWidth(), cw);
            EXPECT_EQ(ag.getHeight(), ch);
        }
        {
            CImage ag = c.grayscale();
            CImage b;
            ag.scaleHalf(b, IMG_INTERP_NN);
            EXPECT_EQ(b.getWidth(), cw / 2);
            EXPECT_EQ(b.getHeight(), ch / 2);
            EXPECT_EQ(ag.getWidth(), cw);
            EXPECT_EQ(ag.getHeight(), ch);
        }
    }  // two passes

    {
        CImage b;
        a.scaleHalf(b, IMG_INTERP_LINEAR);
        EXPECT_EQ(b.getWidth(), a.getWidth() / 2);
        EXPECT_EQ(b.getHeight(), a.getHeight() / 2);
        EXPECT_EQ(a.getWidth(), 320U);
        EXPECT_EQ(a.getHeight(), 240U);
    }
    {
        CImage b;
        a.scaleDouble(b, IMG_INTERP_NN);
        EXPECT_EQ(b.getWidth(), a.getWidth() * 2);
        EXPECT_EQ(b.getHeight(), a.getHeight() * 2);
        EXPECT_EQ(a.getWidth(), 320U);
        EXPECT_EQ(a.getHeight(), 240U);
    }
    {
        CImage b;
        a.scaleDouble(b, IMG_INTERP_LINEAR);
        EXPECT_EQ(b.getWidth(), a.getWidth() * 2);
        EXPECT_EQ(b.getHeight(), a.getHeight() * 2);
        EXPECT_EQ(a.getWidth(), 320U);
        EXPECT_EQ(a.getHeight(), 240U);
    }
}

TEST(CImage, Serialize)
{
    using namespace mrpt::img;
    CImage a;
    bool load_ok = a.loadFromFile(tstImgFileColor);
    EXPECT_TRUE(load_ok);

    mrpt::math::CMatrixFloat am;
    a.getAsMatrix(am, true, 0, 0, -1, -1, false /* dont normalize to [0,1] */);

    mrpt::io::CMemoryStream buf;
    auto arch = mrpt::serialization::archiveFrom(buf);
    arch << a;
    buf.Seek(0);
    CImage b;
    arch >> b;

    mrpt::math::CMatrixFloat bm;
    b.getAsMatrix(bm, true, 0, 0, -1, -1, false /* dont normalize to [0,1] */);

    EXPECT_EQ(am, bm);
}

TEST(CImage, KLT_response)
{
    using namespace mrpt::img;

    {
        CImage a(100, 90, CH_GRAY);
        a.filledRectangle(0, 0, 99, 99, TColor(0x10));
        a.filledRectangle(40, 30, 41, 31, TColor(0x20));

        for (int w = 2; w < 12; w++)
        {
            const auto resp = a.KLT_response(40, 30, w);
            EXPECT_GT(resp, 0.5f);
        }
    }
}

TEST(CImage, LoadAndComparePseudoRnd)
{
    using namespace mrpt::img;
    using namespace std::string_literals;

    const auto tstimg =
        mrpt::UNITTEST_BASEDIR + "/tests/test_pseudorandom_img_seed70.png"s;

    CImage a;
    bool load_ok = a.loadFromFile(tstimg);
    EXPECT_TRUE(load_ok) << "Cannot load: " << tstimg;

    CImage b(10, 7, CH_GRAY);
    fillImagePseudoRandom(70, b);

    expect_identical(a, b, "LoadAndComparePseudoRnd"s);
}

TEST(CImage, LoadAndSave)
{
    using namespace mrpt::img;
    using namespace std::string_literals;

    for (unsigned h = 7; h < 20; h += 17)
    {
        for (unsigned w = 10; w < 33; w++)
        {
            CImage a(w, h, CH_GRAY);
            fillImagePseudoRandom(w * h, a);

            const auto f = mrpt::system::getTempFileName() + ".png"s;

            const auto tstName =
                mrpt::format("From: LoadAndSave test w=%u h=%u", w, h);

            bool saved_ok = a.saveToFile(f);
            EXPECT_TRUE(saved_ok) << tstName;

            CImage b;
            bool load_ok = b.loadFromFile(f);
            EXPECT_TRUE(load_ok) << tstName;

            if (!expect_identical(a, b, tstName))
            {
                GTEST_FAIL() << "a:\n"
                             << a.asCvMatRef() << "\nb:\n"
                             << b.asCvMatRef() << "\n";
            }
        }
    }
}

TEST(CImage, DifferentAccessMethodsColor)
{
    using namespace mrpt::img;
    CImage a;
    bool load_ok = a.loadFromFile(tstImgFileColor);
    EXPECT_TRUE(load_ok);
    EXPECT_TRUE(a.isColor());

    for (unsigned r = 0; r < 3; r++)
    {
        for (unsigned c = 0; c < 3; c++)
        {
            for (int ch = 0; ch < 3; ch++)
            {
                EXPECT_EQ(*a(c, r, ch), a.at<uint8_t>(c, r, ch))
                    << "ch=" << ch << "\n";
                EXPECT_EQ(*a(c, r, ch), *a.ptr<uint8_t>(c, r, ch))
                    << "ch=" << ch << "\n";
                EXPECT_EQ(*a(c, r, ch), a.ptrLine<uint8_t>(r)[c * 3 + ch])
                    << "(c,r,ch)=(" << c << "," << r << "," << ch << ")"
                    << "\n a(c, r, ch)=" << static_cast<void*>(a(c, r, ch))
                    << "\n &a.ptrLine<uint8_t>(r)[c * 3 + ch] = "
                    << static_cast<void*>(&a.ptrLine<uint8_t>(r)[c * 3 + ch])
                    << "\n a(0, r, ch)=" << static_cast<void*>(a(0, r, ch))
                    << "\n a.ptrLine<uint8_t>(r) = "
                    << static_cast<void*>(a.ptrLine<uint8_t>(r)) << "\n";
            }
        }
    }
}

TEST(CImage, DifferentAccessMethodsGray)
{
    using namespace mrpt::img;
    CImage a;
    bool load_ok = a.loadFromFile(tstImgFileColor);
    EXPECT_TRUE(load_ok);
    a = a.grayscale();
    EXPECT_FALSE(a.isColor());

    for (unsigned r = 5; r < 7; r++)
    {
        for (unsigned c = 10; c < 12; c++)
        {
            EXPECT_EQ(*a(c, r), a.at<uint8_t>(c, r));
            EXPECT_EQ(*a(c, r), *a.ptr<uint8_t>(c, r));
            EXPECT_EQ(*a(c, r), a.ptrLine<uint8_t>(r)[c]);
        }
    }
}

#endif  // MRPT_HAS_OPENCV