ITKSphinxExamples icon indicating copy to clipboard operation
ITKSphinxExamples copied to clipboard

Add or update example visuals

Open tbirdso opened this issue 3 years ago • 4 comments

Examples tend to be more compelling and easier to understand when the developer can compare input and output images, and sometimes even interact with the data. A "good first issue" for a contributor could be to choose one of the following examples, read the available code snippet to understand its purpose, and then add one or two visuals to aid in learning.

When selecting visuals to add, consider the following:

  • Static examples such as still 2D images can be particularly useful for developers that are briefly visiting an example. Consider adding at a minimum a 2D input image and 2D output image to load in the user's browser alongside the example.
  • In many cases example images may be more compelling when they represent simplified real-world data rather than contrived instances. Consider using existing scientific data samples such as BrainProtonDensitySliceBorder20.png, cthead1, or HeadMRVolume.mha to illustrate image filter effects, or even add your own public scientific image data.
  • In cases where it is reasonable to generate data, such as visualizing kernels, consider using a library such as matplotlib.pyplot.imshow to construct output visualizations.
  • For 3D cases consider generating screenshots with 3D Slicer, itkwidgets, or ParaView Glance.
  • Please upload data accompanying examples to its respective ITKExamples folder at data.kitware.com (https://data.kitware.com/#collection/57b5c9e58d777f126827f5a1/folder/58bcc0998d777f0aef5d111c). Ask maintainers such as @thewtex or @tbirdso for help if you encounter trouble in creating the appropriate example folder.

Existing example source files such as https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/tree/master/src/Core/Common/AddNoiseToBinaryImage can be referenced for learning how to add new figures to .rst documentation.

The following is a non-exhaustive list of examples that could benefit from new or updated visuals:

tbirdso avatar May 13 '22 15:05 tbirdso

We should add WebAssembly versions of the examples with itk-wasm and UI interfaces with itk-vtk-viewer for interactive examples as @oeway has demonstrated with Kaibu.

thewtex avatar May 15 '22 14:05 thewtex

xref #8

tbirdso avatar May 16 '22 12:05 tbirdso

I am looking into this for ITK Maintenance Hackathon. I shall look into doing WebAssembly versions of some of the examples as well.

jph6366 avatar Jan 13 '25 15:01 jph6366