InsightSoftwareConsortium / InsightSoftwareConsortium/SimpleITK-Notebooks

Improve finding of python classes

Open
#317 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
906
Forks
374
Avg merge
54m
Merged PRs (30d)
1

Description

Let's say I want to find out more about `BinaryDilate`
Here are some approaches:
# A)
Looking in the [simpleitk documentation](https://simpleitk.readthedocs.io/en/master/) search get one hit and that is only the migration guide:
![image](https://user-images.githubusercontent.com/44469195/138475964-f5133868-b8c6-4a3b-8e36-4a1ea621df4d.png)

# B)
In the C++ API I can only find [BinaryDilateImageFilter](https://simpleitk.org/doxygen/latest/html/classitk_1_1simple_1_1BinaryDilateImageFilter.html)
But that does not help me too much in finding out how to e.g. change the `kernelType` parameter.

# C)
Finally, I can search in the [GithubNotebooks repo](https://github.com/InsightSoftwareConsortium/SimpleITK-Notebooks/search?q=BinaryDilate) but also here, not too much information about setting the parameter.
![image](https://user-images.githubusercontent.com/44469195/138476630-f4c63135-2819-4d0f-8452-611e961040f9.png)

# Solutions:

# idea i)
adding a notebook into the notebook gallery, where this parameter is set, e.g. something like this:
https://simpleitk.org/doxygen/latest/html/namespaceitk_1_1simple.html#a38998f2c7b469b1ad8e337a0c6c0697b
![image](https://user-images.githubusercontent.com/44469195/138460543-5f674f54-bf3e-4575-bc23-805bd4a2c9cf.png)

# idea ii)
adding more documentation about how to set parameters in python at simpleitk.readthedocs.io

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.