Merge pull request #2401 from SCIInstitute/2400-fit-region-value

Resolve #2400 - Feature Request: Add padding value parameter for Image::fitRegion

Author: akenmorris

Libs/Image/Image.cpp

@@ -757,14 +757,14 @@ Image& Image::crop(PhysicalRegion region, const int padding) {
   return *this;
 }
 
-Image& Image::fitRegion(PhysicalRegion region) {
+Image& Image::fitRegion(PhysicalRegion region, const PixelType value) {
   // first pad to make sure the image is large enough to fit the region
 
   // convert PhysicalRegion to IndexRegion
   IndexRegion indexRegion(physicalToLogical(region));
 
   // pad the image
-  pad(indexRegion, 0);
+  pad(indexRegion, value);
 
   // fix origin and indices
   using RegionFilterType = itk::RegionOfInterestImageFilter<ImageType, ImageType>;

Libs/Image/Image.h

@@ -189,7 +189,7 @@ class Image {
   Image& crop(PhysicalRegion region, const int padding = 0);
 
   /// crops (or pads) the image to fit the given region
-  Image& fitRegion(PhysicalRegion region);
+  Image& fitRegion(PhysicalRegion region, const PixelType value = 0.0);
 
   /// clips an image using a cutting plane
   Image& clip(const Plane plane, const PixelType val = 0.0);

Libs/Python/ShapeworksPython.cpp

@@ -346,7 +346,8 @@ PYBIND11_MODULE(shapeworks_py, m) {
       .def("crop", &Image::crop, "crops the image down to the given (physical) region, with optional padding",
            "region"_a, "padding"_a = 0)
 
-      .def("fitRegion", &Image::fitRegion, "crops or pads the image to fit a region", "region"_a)
+      .def("fitRegion", &Image::fitRegion, "crops or pads the image to fit a region with optional padding value",
+           "region"_a, "value"_a = 0)
 
       .def(
           "clip",

Testing/PythonTests/PythonTests.cpp

@@ -346,3 +346,7 @@ TEST(pythonTests, projectTest) {
 TEST(pythonTests, thicknessTest) {
   run_test("thickness.py");
 }
+
+TEST(pythonTests, fitRegionTest) {
+  run_test("fitregion.py");
+}

Testing/PythonTests/fitregion.py

@@ -0,0 +1,40 @@
+import os
+import sys
+from shapeworks import *
+
+success = True
+
+def fitRegion1():
+  img = Image(os.environ["DATA"] + "/seg.ellipsoid_1.nrrd")
+
+  region = img.logicalBoundingBox().pad(16)
+
+  region.min[0] = 7
+  region.max[0] = 42
+
+  img.fitRegion(img.logicalToPhysical(region))
+
+#  img.write(os.environ["DATA"] + "/fitregion1_baseline.nrrd")
+  compareImg = Image(os.environ["DATA"] + "/fitregion1_baseline.nrrd")
+
+  return img.compare(compareImg)
+
+success &= utils.test(fitRegion1)
+
+
+def fitRegion2():
+  img = Image(os.environ["DATA"] + "/seg.ellipsoid_1.nrrd")
+
+  region = img.logicalBoundingBox().pad(16)
+
+  region.min[0] = 7
+  region.max[0] = 42
+
+  img.fitRegion(img.logicalToPhysical(region), -2000)
+
+#  img.write(os.environ["DATA"] + "/fitregion2_baseline.nrrd")
+  compareImg = Image(os.environ["DATA"] + "/fitregion2_baseline.nrrd")
+
+  return img.compare(compareImg)
+
+success &= utils.test(fitRegion2)

Testing/data/fitregion1_baseline.nrrd

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:260e5facb19fde257f135274ee472d06144314e08c945f236adbcd1a94d873c8
+size 2760

Testing/data/fitregion2_baseline.nrrd

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5f80da8d7c7244a258b28051b6ce8ad5be628ed4a9836c20302e431371555a1a
+size 5771