search

dkazanc / TomoPhantom

Software to generate 2D/3D/4D analytical phantoms and their Radon transforms (parallel beam) for image processing
https://dkazanc.github.io/TomoPhantom/
Apache License 2.0
116 stars 53 forks source link

Docs/API somewhere? #117

Open jnahlers opened 11 months ago

jnahlers commented 11 months ago

Great software! I may have missed this, but is there some documentation and/or API reference somewhere?

dkazanc commented 11 months ago

Thanks, I'm currently refactoring software to make various development related processes much easier. With that I'm hoping of adding proper Documentation page on Github Pages. Hopefully it will go live in the next couple of days. For now you can have a look at some of API bits mentioned in the paper. Will update the issue, when Docs are live.

dkazanc commented 11 months ago

Hi please find all API references here. thanks!

jnahlers commented 10 months ago

@dkazanc The one thing I'm still not sure about is the various object parameters (e.g. Obj, a, phi1, C0, etc.). Perhaps it would be good to include a list of all of them, what they do, and what values they can take somewhere in the docs.

dkazanc commented 10 months ago

thanks, it does indeed will be helpful to describe. Will try to find some time to do it at some point :)