Merge pull request #440 from jph6366/Add-or-Update-Example-Visuals

thewtex · web-flow · commit 6b7cec53b785 · 2025-03-11T13:40:17.000-04:00
DOC: Add or update example visuals
diff --git a/src/Core/Common/ApplyAFilterOnlyToASpecifiedRegionOfAnImage/Documentation.rst b/src/Core/Common/ApplyAFilterOnlyToASpecifiedRegionOfAnImage/Documentation.rst
@@ -17,10 +17,18 @@ That is, to tell the DerivativeImageFilter to only operate on a small region, yo
   derivativeFilter->GetOutput()->SetRequestedRegion(smallRegion);
   derivativeFilter->Update();
 
+.. figure:: FilterImageRegion.png
+  :scale: 70%
+  :alt: FilterImageRegion.png
+
 
 Results
 -------
 
+.. figure:: Relationship.png
+  :scale: 70%
+  :alt: relationship.png
+
 
 Code
 ----
diff --git a/src/Core/Common/ApplyAFilterOnlyToASpecifiedRegionOfAnImage/FilterImageRegion.png.cid b/src/Core/Common/ApplyAFilterOnlyToASpecifiedRegionOfAnImage/FilterImageRegion.png.cid
@@ -0,0 +1 @@
+bafkreie4uitslnavl6u3s4w62gkz6r3wssoctdav7zaqmrt4xfasouf6f4
diff --git a/src/Core/Common/ApplyAFilterOnlyToASpecifiedRegionOfAnImage/Relationship.png.cid b/src/Core/Common/ApplyAFilterOnlyToASpecifiedRegionOfAnImage/Relationship.png.cid
@@ -0,0 +1 @@
+bafkreiaffqu7nnoby6ix5o3pg5eiucj7ofsxx3wnij4r2kugbdy4jhvuia
diff --git a/src/Core/Common/ApplyCustomOperationToEachPixelInImage/Documentation.rst b/src/Core/Common/ApplyCustomOperationToEachPixelInImage/Documentation.rst
@@ -10,6 +10,16 @@ Synopsis
 --------
 Apply a custom operation to each pixel in an image.
 
+.. figure:: Relationship.png
+  :scale: 70%
+  :alt: Relationship.png
+
+
+.. figure:: Operator.png
+  :scale: 70%
+  :alt: Operator.png
+
+pixel-wise operation on 2D vector image.
 
 Results
 -------
diff --git a/src/Core/Common/ApplyCustomOperationToEachPixelInImage/Operation.png.cid b/src/Core/Common/ApplyCustomOperationToEachPixelInImage/Operation.png.cid
@@ -0,0 +1 @@
+bafkreig3f4d5hwfz2wzmy56o6tc5mb3ljd6jmtsjoruxqfchlz5yv6ixuy
diff --git a/src/Core/Common/ApplyCustomOperationToEachPixelInImage/Relationship.png.cid b/src/Core/Common/ApplyCustomOperationToEachPixelInImage/Relationship.png.cid
@@ -0,0 +1 @@
+bafkreihasqn5hlzyvlxkjqjfv5tupvvyixfiknai2puytootv523dd3tcq
diff --git a/src/Core/Common/BoundingBoxOfAPointSet/BoundingBox.png.cid b/src/Core/Common/BoundingBoxOfAPointSet/BoundingBox.png.cid
@@ -0,0 +1 @@
+bafkreickdblw4cjduumqnb7gn3wtsjshvqrvezh3k7krz657xsosvur2ry
diff --git a/src/Core/Common/BoundingBoxOfAPointSet/Documentation.rst b/src/Core/Common/BoundingBoxOfAPointSet/Documentation.rst
@@ -16,7 +16,9 @@ Get the bounding box of a PointSet
 
 Results
 -------
-
+.. figure:: BoundingBox.png
+  :scale: 70%
+  :alt: BoundingBox.png
 
 Output::
   bounds: [0, 0.1, 0, 0.1, 0, 0]
diff --git a/src/Core/Common/BresenhamLine/Documentation.rst b/src/Core/Common/BresenhamLine/Documentation.rst
@@ -14,6 +14,15 @@ Get the points on a Bresenham line between two points.
 
 Results
 -------
+.. figure:: Segmentation.png
+  :scale: 70%
+  :alt: Segmentation.png
+
+  ITK's Bresenham's Line algorithm is used and optimized for voxel traversal operations.
+
+.. figure:: Operation.png
+  :scale: 70%
+  :alt: Operation.png
 
 Output::
 
diff --git a/src/Core/Common/BresenhamLine/Operation.png.cid b/src/Core/Common/BresenhamLine/Operation.png.cid
@@ -0,0 +1 @@
+bafkreia4xxrlmsbcivkpdtl2ja2mskpuuaht43rmmrt2j3qjqp5ymsf2v4
diff --git a/src/Core/Common/BresenhamLine/Segmentation.png.cid b/src/Core/Common/BresenhamLine/Segmentation.png.cid
@@ -0,0 +1 @@
+bafkreihi6qoq7pqyqf3defuwz7ntxspjurtywy73iba4eyaaqgfm6lmbg4
diff --git a/src/Core/Common/CMakeLists.txt b/src/Core/Common/CMakeLists.txt
@@ -1,5 +1,11 @@
 add_example(CreateACovariantVector)
 add_example(CreateAPointSet)
+
+add_example(ReadAPointSet)
+compare_to_baseline(EXAMPLE_NAME ReadAPointSet
+  BASELINE_PREFIX ReadAPointSet
+  )
+
 add_example(DoDataParallelThreading)
 add_example(CovariantVectorNorm)
 add_example(CovariantVectorDotProduct)
diff --git a/src/Core/Common/ConvertArrayToImage/ConvertArrayToImageOutput.png.cid b/src/Core/Common/ConvertArrayToImage/ConvertArrayToImageOutput.png.cid
diff --git a/src/Core/Common/ConvertArrayToImage/Documentation.rst b/src/Core/Common/ConvertArrayToImage/Documentation.rst
@@ -13,14 +13,26 @@ Synopsis
 
 Convert a C-style array to an itkImage.
 
+.. figure:: Relationship.png
+  :scale: 70%
+  :alt: relationship.png
+
+  Relationship between ProcessObjects and DataObjects
+
 
 Results
 -------
-.. figure:: ConvertArrayToImageOutput.png
+.. figure:: Sphere.png
+  :scale: 70%
+  :alt: sphere.png
+
+  Slice of 3D image
+
+.. figure:: Sphere3D.png
   :scale: 70%
-  :alt: test.png
+  :alt: sphere.png
 
-  Output Image.
+  3D volume rendering of 3D image
 
 Code
 ----
diff --git a/src/Core/Common/ConvertArrayToImage/Relationship.png.cid b/src/Core/Common/ConvertArrayToImage/Relationship.png.cid
@@ -0,0 +1 @@
+bafkreihcn43nd4b5dthz4yrq77tyjjfelpvzzmiutnm2slpaznnrscowoq
diff --git a/src/Core/Common/ConvertArrayToImage/Sphere.png.cid b/src/Core/Common/ConvertArrayToImage/Sphere.png.cid
@@ -0,0 +1 @@
+bafkreifj3dfi57rvwruuvk5ycftmobp2p5mdho7qpi7x7ykuujbkzb2lca
diff --git a/src/Core/Common/ConvertArrayToImage/Sphere3D.png.cid b/src/Core/Common/ConvertArrayToImage/Sphere3D.png.cid
@@ -0,0 +1 @@
+bafkreid3uloy2yfjqggy5d46aghpb4b5v3q2xaqylkg2uoqsuqc5dh4s7q
diff --git a/src/Core/Common/CreateDerivativeKernel/DerivativeKernel.png.cid b/src/Core/Common/CreateDerivativeKernel/DerivativeKernel.png.cid
@@ -0,0 +1 @@
+bafkreigdntizd2xiqvwywb6vab4wwbxcozlm4yghjkoc7dzugzipvhudne
diff --git a/src/Core/Common/CreateDerivativeKernel/DerivativeOperator.png.cid b/src/Core/Common/CreateDerivativeKernel/DerivativeOperator.png.cid
@@ -0,0 +1 @@
+bafkreibohzttygqnnh25zror2z5vlhypmwtvfgyvqrfebhcxvme7mehbvy
diff --git a/src/Core/Common/CreateDerivativeKernel/Documentation.rst b/src/Core/Common/CreateDerivativeKernel/Documentation.rst
@@ -12,9 +12,15 @@ Synopsis
 
 Create a derivative kernel.
 
+.. figure:: DerivativeOperator.png
+  :scale: 70%
+  :alt: DerivativeOperator.png
+
+Applied a neighborhood iterator using a first-order derivative operator to approximate y-derivative
 
 Results
 -------
+
 Output::
 
   Size: [3, 3]
@@ -32,6 +38,13 @@ Output::
   [0, 1] 0
   [1, 1] 0
 
+
+.. figure:: DerivativeKernel.png
+  :scale: 70%
+  :alt: DerivativeKernel.png
+
+
+
 Code
 ----
 
diff --git a/src/Core/Common/CreateGaussianKernel/Documentation.rst b/src/Core/Common/CreateGaussianKernel/Documentation.rst
@@ -12,9 +12,15 @@ Synopsis
 
 Create a Gaussian kernel.
 
+.. figure:: GaussianBlur.png
+  :scale: 70%
+  :alt: GaussianBlur.png
+
+Results of convolution filtering with a Gaussian kernel of increasing standard deviation σ
 
 Results
 -------
+
 Output::
 
   Size: [3, 3]
@@ -32,6 +38,9 @@ Output::
   [0, 1] 0
   [1, 1] 0
 
+.. figure:: GaussianKernel.png
+  :scale: 70%
+  :alt: GaussianKernel.png
 
 Code
 ----
diff --git a/src/Core/Common/CreateGaussianKernel/GaussianBlur.png.cid b/src/Core/Common/CreateGaussianKernel/GaussianBlur.png.cid
@@ -0,0 +1 @@
+bafkreifsacuklxb4nc4zo3g3dug7xvsf4kcpt5oosguhcngq5pysgqgnia
diff --git a/src/Core/Common/CreateGaussianKernel/GaussianKernel.png.cid b/src/Core/Common/CreateGaussianKernel/GaussianKernel.png.cid
@@ -0,0 +1 @@
+bafkreidlnhsxjw7ivecwinizozzrss54z3hoezddflwcwfag2f7gqjqxgm
diff --git a/src/Core/Common/CreateVectorImage/Documentation.rst b/src/Core/Common/CreateVectorImage/Documentation.rst
@@ -11,6 +11,11 @@ Synopsis
 
 Create a vector image.
 
+.. figure:: Operation.png
+  :scale: 70%
+  :alt: operation.png
+
+How the image whose pixels are of vector type can be set using a VariableLengthVector at runtime
 
 Results
 -------
diff --git a/src/Core/Common/CreateVectorImage/Operation.png.cid b/src/Core/Common/CreateVectorImage/Operation.png.cid
@@ -0,0 +1 @@
+bafkreiefasljtdb5w2lpiw3kptqknfqdngzgq6waff2ims43wwsapnjnba
diff --git a/src/Core/Common/CropImageBySpecifyingRegion/3DVolume.png.cid b/src/Core/Common/CropImageBySpecifyingRegion/3DVolume.png.cid
@@ -0,0 +1 @@
+bafkreihtmliqoydru3yo5sbxsddu4sq4hkt6q5e6tnrawz4vbtqrjtwama
diff --git a/src/Core/Common/CropImageBySpecifyingRegion/Documentation.rst b/src/Core/Common/CropImageBySpecifyingRegion/Documentation.rst
@@ -12,6 +12,15 @@ Synopsis
 
 Crop an image by specifying the region to keep.
 
+.. figure:: 3DVolume.png
+  :scale: 70%
+  :alt: 3dvolume.png
+
+.. figure:: ExtractedSlice.png
+  :scale: 70%
+  :alt: extractedslice.png
+
+Extracting a 2D slice from a 3D volume.
 
 Results
 -------
diff --git a/src/Core/Common/CropImageBySpecifyingRegion/ExtractedSlice.png.cid b/src/Core/Common/CropImageBySpecifyingRegion/ExtractedSlice.png.cid
@@ -0,0 +1 @@
+bafkreihbzuilqqwwwoyfhhmke6vb5fby2llly3rmtujmbfujdl2qr3obvu
diff --git a/src/Core/Common/ImageRegionIntersection/Documentation.rst b/src/Core/Common/ImageRegionIntersection/Documentation.rst
@@ -13,6 +13,11 @@ Synopsis
 
 This example demonstrates how to check if two regions of an image overlap/intersect.
 
+.. figure:: ImageRegionIntersection.png
+  :scale: 70%
+  :alt: imageregionintersection.png
+
+
 
 Results
 -------
diff --git a/src/Core/Common/ImageRegionIntersection/ImageRegionIntersection.png.cid b/src/Core/Common/ImageRegionIntersection/ImageRegionIntersection.png.cid
@@ -0,0 +1 @@
+bafkreih5hkqhoalqpj27vwj7qlq2krgzoxerkgil2ix5ggyh4u5gickawq
diff --git a/src/Core/Common/MakePartOfImageTransparent/Documentation.rst b/src/Core/Common/MakePartOfImageTransparent/Documentation.rst
@@ -12,6 +12,10 @@ Synopsis
 
 Demonstrates how to assign transparency to pixels in an image, then writing the result to a tif file for inspection and verification.
 
+.. figure:: Transparency.png
+  :scale: 70%
+  :alt: Transparency.png
+
 
 Results
 -------
diff --git a/src/Core/Common/MakePartOfImageTransparent/Transparency.png.cid b/src/Core/Common/MakePartOfImageTransparent/Transparency.png.cid
@@ -0,0 +1 @@
+bafkreickuima2tmul6deufw2xz4tntnq6buzondwva6c34mq3abzkfbdfm
diff --git a/src/Core/Common/MiniPipeline/Documentation.rst b/src/Core/Common/MiniPipeline/Documentation.rst
@@ -11,6 +11,11 @@ Synopsis
 
 Mini Pipeline.
 
+.. figure:: MiniPipeline.png
+  :scale: 70%
+  :alt: MiniPipeline.png
+
+Example of a typical mini pipeline or composite filter that can encapsulate a number of other filters.
 
 Results
 -------
diff --git a/src/Core/Common/MiniPipeline/MiniPipeline.png.cid b/src/Core/Common/MiniPipeline/MiniPipeline.png.cid
@@ -0,0 +1 @@
+bafkreiact2ar5jwdldtg7xdkma4goxozct64cwstqcdl3wwib2mycjaeia
diff --git a/src/Core/Common/ReadAPointSet/CMakeLists.txt b/src/Core/Common/ReadAPointSet/CMakeLists.txt
@@ -21,4 +21,5 @@ install(FILES Code.cxx CMakeLists.txt
 enable_testing()
 add_test(NAME ReadAPointSetTest
   COMMAND ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${PROJECT_NAME}
+  tetrahedron.vtk
 )
diff --git a/src/Core/Common/ReadAPointSet/Documentation.rst b/src/Core/Common/ReadAPointSet/Documentation.rst
@@ -17,9 +17,30 @@ Read a PointSet
 
 Results
 -------
+.. figure:: tetrahedron.png
+  :scale: 70%
+  :alt: InputVTK.png
 
 Print all points
 
+.. raw:: html
+
+  <div class="figure">
+    <iframe src="XTKViewer.html" width="400" height="450" seamless></iframe>
+    <p class="caption">Interactive input mesh</p>
+  </div>
+
+
+Output::
+
+   Input file: tetrahedron.vtk
+   Testing itk::VTKPolyDataReader
+   numberOfPoints= 4
+   numberOfCells= 4
+   Point is = [0.5, 0, 0]
+   Point is = [-0.5, 0.5, 0]
+   Point is = [-0.5, -0.25, 0.433013]
+   Point is = [-0.5, -0.25, -0.433013]
 
 Code
 ----
@@ -30,6 +51,13 @@ C++
 .. literalinclude:: Code.cxx
    :lines: 18-
 
+WebAssembly
+......
+
+.. literalinclude:: WebAssembly.html
+   :language: html
+   :lines: 1, 20-
+
 
 Classes demonstrated
 --------------------
diff --git a/src/Core/Common/ReadAPointSet/WebAssembly.html b/src/Core/Common/ReadAPointSet/WebAssembly.html
@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>itk-wasm Browser Hello World!</title>
+    <meta charset="UTF-8" />
+    <script src="https://cdn.jsdelivr.net/npm/itk-wasm@1.0.0-b.106/dist/umd/itk-wasm.min.js"></script>
+  </head>
+
+  <body>
+    <textarea readonly>WebAssembly output...</textarea>
+
+    <script>
+      const outputTextArea = document.querySelector("textarea");
+      outputTextArea.textContent = "Loading...";
+
+      const wasmURL = new URL('emscripten-build/ReadAPointSet', document.location)
+      const args = []
+      const inputs = null
+      const outputs = null
+      itk.runPipeline(null, wasmURL, args, inputs, outputs).then(
+        ({ stdout, webWorker }) => {
+          webWorker.terminate()
+          outputTextArea.textContent = stdout
+          })
+    </script>
+  </body>
+</html>
diff --git a/src/Core/Common/ReadAPointSet/XTKViewer.html b/src/Core/Common/ReadAPointSet/XTKViewer.html
diff --git a/src/Core/Common/ReadAPointSet/tetrahedron.png.cid b/src/Core/Common/ReadAPointSet/tetrahedron.png.cid
diff --git a/src/Core/Common/ReadAPointSet/tetrahedron.vtk.cid b/src/Core/Common/ReadAPointSet/tetrahedron.vtk.cid

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+bafkreie4uitslnavl6u3s4w62gkz6r3wssoctdav7zaqmrt4xfasouf6f4`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+bafkreiaffqu7nnoby6ix5o3pg5eiucj7ofsxx3wnij4r2kugbdy4jhvuia`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+bafkreig3f4d5hwfz2wzmy56o6tc5mb3ljd6jmtsjoruxqfchlz5yv6ixuy`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+bafkreihasqn5hlzyvlxkjqjfv5tupvvyixfiknai2puytootv523dd3tcq`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+bafkreickdblw4cjduumqnb7gn3wtsjshvqrvezh3k7krz657xsosvur2ry`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+bafkreia4xxrlmsbcivkpdtl2ja2mskpuuaht43rmmrt2j3qjqp5ymsf2v4`