Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add or update example visuals #359

Open
53 tasks
tbirdso opened this issue May 13, 2022 · 3 comments
Open
53 tasks

Add or update example visuals #359

tbirdso opened this issue May 13, 2022 · 3 comments
Assignees
Labels
Good first issue A good issue for community members new to contributing type:Data Changes to example data (usually displayed images)

Comments

@tbirdso
Copy link
Contributor

tbirdso commented May 13, 2022

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 tbirdso added Good first issue A good issue for community members new to contributing type:Data Changes to example data (usually displayed images) labels May 13, 2022
@thewtex
Copy link
Member

thewtex commented May 15, 2022

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.

@tbirdso
Copy link
Contributor Author

tbirdso commented May 16, 2022

xref #8

@jph6366
Copy link

jph6366 commented Jan 13, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good first issue A good issue for community members new to contributing type:Data Changes to example data (usually displayed images)
Projects
None yet
Development

No branches or pull requests

3 participants