fixNonFinite doc2test

Signed-off-by: Daniel Greenstein <[email protected]>

Author: grdanny

src/doc/imagebufalgo.rst

@@ -2534,26 +2534,30 @@ Image Enhancement / Restoration
   Result-as-parameter version:
     .. doxygenfunction:: fixNonFinite(ImageBuf &dst, const ImageBuf &src, NonFiniteFixMode mode = NONFINITE_BOX3, int *pixelsFixed = nullptr, ROI roi = {}, int nthreads = 0)
 
+
   Examples:
 
-    .. tabs::
-  
-       .. code-tab:: c++
+   .. tabs::
 
-          ImageBuf Src ("tahoe.exr");
-          int pixelsFixed = 0;
-          ImageBufAlgo::fixNonFinite (Src, Src, ImageBufAlgo::NONFINITE_BOX3,
-                                      &pixelsFixed);
-          std::cout << "Repaired " << pixelsFixed << " non-finite pixels\n";
+      .. tab:: C++
+         .. literalinclude:: ../../testsuite/docs-examples-cpp/src/docs-examples-imagebufalgo.cpp
+              :language: c++
+              :start-after: BEGIN-imagebufalgo-fixNonFinite
+              :end-before: END-imagebufalgo-fixNonFinite
+              :dedent: 4
 
-       .. code-tab:: py
+      .. tab:: Python
+         .. literalinclude:: ../../testsuite/docs-examples-python/src/docs-examples-imagebufalgo.py
+              :language: py
+              :start-after: BEGIN-imagebufalgo-fixNonFinite
+              :end-before: END-imagebufalgo-fixNonFinite
+              :dedent: 4
 
-          Src = ImageBuf("tahoe.exr")
-          ImageBufAlgo.fixNonFinite (Src, Src, "box3", oiio.NONFINITE_BOX3)
+      .. tab:: oiiotool
+         .. sourcecode:: bash
 
-       .. code-tab:: bash oiiotool
+            oiiotool with_nans.tif --fixnan box3 -o with_nans_fixed.tif
 
-          oiiotool tahoe.exr --fixnan box3 -o fixed.exr
 
 |
 

testsuite/common/with_nans.tif

@@ -27,6 +27,8 @@ example_resize
 example_resample
 example_fit
 example_warp
+example_fixNonFinite
+Repaired 48 non-finite pixels
 example_make_texture
 zero1.exr            :  512 x  512, 3 channel, half openexr
     SHA-1: 95823C334FCE55968E8D2827CCD1CF77CEE19ABD
@@ -106,6 +108,8 @@ cshift.exr           :  256 x  256, 4 channel, half openexr
     SHA-1: 000F95FDC44D4DBDA8B4041C2506149C7AE28ACA
 texture.exr          :  256 x  256, 3 channel, half openexr (+mipmap)
     SHA-1: 4074B050432CE7C664CEC4546A46E74F9A310CDC
+with_nans_fixed.tif  :  256 x  256, 3 channel, float tiff
+    SHA-1: FE830FB041FAE5F1AA16B23FB69B91DED4BF5B73
 Comparing "simple.tif" and "ref/simple.tif"
 PASS
 Comparing "scanlines.tif" and "ref/scanlines.tif"

testsuite/docs-examples-cpp/ref/out.txt

@@ -13,6 +13,7 @@
 # Prep:
 command += run_app("cmake -E copy " + test_source_dir + "/../common/grid-small.exr grid.exr")
 command += run_app("cmake -E copy " + test_source_dir + "/../common/tahoe-small.tif tahoe.tif")
+command += run_app("cmake -E copy " + test_source_dir + "/../common/with_nans.tif with_nans.tif")
 
 # Build
 command += run_app("cmake -S " + test_source_dir + " -B build -DCMAKE_BUILD_TYPE=Release >> build.txt 2>&1", silent=True)
@@ -68,7 +69,8 @@
     "transpose.exr",
     "reorient.exr",
     "cshift.exr",
-    "texture.exr"
+    "texture.exr",
+    "with_nans_fixed.tif"
 ]
 for file in hashes :
     command += info_command(file, verbose=False)

testsuite/docs-examples-cpp/run.py

@@ -504,7 +504,19 @@ void example_warp()
 
 // Section: Image enhancement / restoration
 
+void example_fixNonFinite()
+{
+    print("example_fixNonFinite\n");
+    // BEGIN-imagebufalgo-fixNonFinite
+    ImageBuf Src ("with_nans.tif");
+    int pixelsFixed = 0;
+    ImageBufAlgo::fixNonFinite (Src, Src, ImageBufAlgo::NONFINITE_BOX3,
+                            &pixelsFixed);
+    std::cout << "Repaired " << pixelsFixed << " non-finite pixels\n";
+    // END-imagebufalgo-fixNonFinite
+    Src.write("with_nans_fixed.tif");
 
+}
 // Section: Morphological filters
 
 
@@ -579,6 +591,8 @@ int main(int /*argc*/, char** /*argv*/)
 
     // Section: Image enhancement / restoration
 
+    example_fixNonFinite();
+
     // Section: Morphological filters
 
     // Section: Color space conversion

testsuite/docs-examples-cpp/src/docs-examples-imagebufalgo.cpp

@@ -28,6 +28,7 @@ example_resize
 example_resample
 example_fit
 example_warp
+example_fixNonFinite
 example_make_texture
 zero1.exr            :  512 x  512, 3 channel, half openexr
     SHA-1: 95823C334FCE55968E8D2827CCD1CF77CEE19ABD
@@ -107,6 +108,8 @@ cshift.exr           :  256 x  256, 4 channel, half openexr
     SHA-1: 000F95FDC44D4DBDA8B4041C2506149C7AE28ACA
 texture.exr          :  256 x  256, 3 channel, half openexr (+mipmap)
     SHA-1: 4074B050432CE7C664CEC4546A46E74F9A310CDC
+with_nans_fixed.tif  :  256 x  256, 3 channel, float tiff
+    SHA-1: FE830FB041FAE5F1AA16B23FB69B91DED4BF5B73
 Comparing "simple.tif" and "../docs-examples-cpp/ref/simple.tif"
 PASS
 Comparing "scanlines.tif" and "../docs-examples-cpp/ref/scanlines.tif"

testsuite/docs-examples-python/ref/out.txt

@@ -13,6 +13,7 @@
 # Prep:
 command += run_app("cmake -E copy " + test_source_dir + "/../common/grid-small.exr grid.exr")
 command += run_app("cmake -E copy " + test_source_dir + "/../common/tahoe-small.tif tahoe.tif")
+command += run_app("cmake -E copy " + test_source_dir + "/../common/with_nans.tif with_nans.tif")
 
 # Run the examples for each chapter
 for chapter in [ "imageioapi", "imageoutput", "imageinput", "writingplugins",
@@ -64,8 +65,10 @@
     "transpose.exr",
     "reorient.exr",
     "cshift.exr",
-    "texture.exr"
+    "texture.exr",
+    "with_nans_fixed.tif"
 ]
+
 for file in hashes :
     command += info_command(file, verbose=False)
 

testsuite/docs-examples-python/run.py

@@ -446,6 +446,12 @@ def example_warp():
 
 # Section: Image enhancement / restoration
 
+def example_fixNonFinite():
+    print("example_fixNonFinite")
+    Src = ImageBuf("with_nans.tif")
+    ImageBufAlgo.fixNonFinite (Src, Src, oiio.NONFINITE_BOX3)
+    Src.write("with_nans_fixed.tif")
+
 
 # Section: Morphological filters
 
@@ -517,6 +523,7 @@ def example_make_texture():
     # Section: Convolution and frequency-space algorithms
 
     # Section: Image enhancement / restoration
+    example_fixNonFinite()
 
     # Section: Morphological filters