Implemented ImagePyramid::getLevelSizes(), added some more tests, and added additional checks to constructor when levelSizes is provided.

Author: smistad

source/FAST/Data/ImagePyramid.cpp

@@ -101,6 +101,16 @@ ImagePyramid::ImagePyramid(int width, int height, int channels, int patchWidth,
                     break;
                 if(levelSizes[currentLevel-1].x() <= 2 && levelSizes[currentLevel-1].y() <= 2)
                     throw Exception("Invalid level size smaller than 2");
+                if(currentLevel == 1 && levelSizes[0].x() == currentWidth && levelSizes[0].y() == currentHeight) {
+                    // User has specified width and height of level 0 in levelSizes: skip it, as this level is already created
+                    ++currentLevel;
+                    continue;
+                }
+                if(levelSizes[currentLevel-1].x() >= currentWidth || levelSizes[currentLevel-1].y() >= currentHeight)
+                    throw Exception("Invalid level size, each size must be smaller than previous level."
+                                    "Current: " + std::to_string(currentWidth) + " " + std::to_string(currentHeight) + " "
+                                    "Next: " + std::to_string(levelSizes[currentLevel-1].x()) + " " +  std::to_string(levelSizes[currentLevel-1].y())
+                    );
                 currentWidth = levelSizes[currentLevel-1].x();
                 currentHeight = levelSizes[currentLevel-1].y();
             } else if(!levelDownsamples.empty()) {
@@ -683,4 +693,12 @@ int ImagePyramid::getWidth() const {
 int ImagePyramid::getHeight() const {
     return getLevelHeight(0);
 }
+
+std::vector<Vector2i> ImagePyramid::getLevelSizes() const {
+    std::vector<Vector2i> sizes;
+    for(int i = 0; i < getNrOfLevels(); ++i) {
+        sizes.emplace_back(getLevelWidth(i), getLevelHeight(i));
+    }
+    return sizes;
+}
 }

source/FAST/Data/ImagePyramid.hpp

@@ -82,11 +82,16 @@ class FAST_EXPORT ImagePyramid : public SpatialDataObject {
         int getFullHeight();
         int getWidth() const;
         int getHeight() const;
+        /**
+         * @brief Get size (width and height) for each level in the image pyramid
+         * @return list of image pyramid level sizes
+         */
+        std::vector<Vector2i> getLevelSizes() const;
         int getNrOfChannels() const;
         bool isBGRA() const;
         bool usesTIFF() const;
         /**
-         * Whether all patches in entire pyramid has been initialized.
+         * @brief Whether all patches in entire pyramid has been initialized.
          */
         bool isPyramidFullyInitialized() const;
         bool usesOpenSlide() const;

source/FAST/Data/Tests/ImagePyramidTests.cpp

@@ -180,3 +180,56 @@ TEST_CASE("Create image pyramid with custom level sizes", "[fast][ImagePyramid]"
     CHECK(pyramid->getLevelScale(1) == Approx(1.5f).margin(0.01));
     CHECK(pyramid->getLevelScale(2) == Approx(4.5f).margin(0.01));
 }
+
+TEST_CASE("Create image pyramid with custom level sizes including level 0", "[fast][ImagePyramid]") {
+    std::vector<Vector2i> sizes = {
+            {22000, 13000},
+            {22000/1.5f, 13000/1.5f},
+            {22000/4.5f, 13000/4.5f}
+    };
+    auto pyramid = ImagePyramid::create(22000, 13000, 1, 512, 512, ImageCompression::JPEG, 90,
+                                        fast::TYPE_UINT8, {}, sizes);
+
+    CHECK(pyramid->getNrOfLevels() == 3);
+    CHECK(pyramid->getWidth() == 22000);
+    CHECK(pyramid->getHeight() == 13000);
+    CHECK(pyramid->getLevelWidth(1) == sizes[1].x());
+    CHECK(pyramid->getLevelHeight(1) == sizes[1].y());
+    CHECK(pyramid->getLevelWidth(2) == sizes[2].x());
+    CHECK(pyramid->getLevelHeight(2) == sizes[2].y());
+    CHECK_THROWS(pyramid->getLevelWidth(3));
+    CHECK(pyramid->getDataType() == TYPE_UINT8);
+    CHECK(pyramid->getLevelTileWidth(0) == 512);
+    CHECK(pyramid->getLevelTileHeight(0) == 512);
+    CHECK(pyramid->getCompression() == ImageCompression::JPEG);
+    CHECK(pyramid->getNrOfChannels() == 1);
+    CHECK(pyramid->getLevelScale(0) == Approx(1.0f).margin(0.01));
+    CHECK(pyramid->getLevelScale(1) == Approx(1.5f).margin(0.01));
+    CHECK(pyramid->getLevelScale(2) == Approx(4.5f).margin(0.01));
+}
+
+TEST_CASE("Invalid level sizes", "[fast][ImagePyramid]") {
+    std::vector<Vector2i> sizes = {
+            {24000, 13000},
+            {128, 128}
+    };
+    CHECK_THROWS(
+        auto pyramid = ImagePyramid::create(22000, 13000, 1, 512, 512, ImageCompression::JPEG, 90,
+                                        fast::TYPE_UINT8, {}, sizes);
+    );
+
+}
+
+TEST_CASE("getLevelSizes", "[fast][ImagePyramid]") {
+    std::vector<Vector2i> sizes = {
+            {22000, 13000},
+            {22000/1.5f, 13000/1.5f},
+            {22000/4.5f, 13000/4.5f}
+    };
+    auto pyramid = ImagePyramid::create(22000, 13000, 1, 512, 512, ImageCompression::JPEG, 90,
+                                        fast::TYPE_UINT8, {}, sizes);
+    auto levelSizes = pyramid->getLevelSizes();
+    for(int i = 0; i < 3; ++i) {
+        CHECK(levelSizes[i] == sizes[i]);
+    }
+}