Migrate documentation for individual functions from the HeterogeneityCAD wiki

AIM-Harvard / pyradiomics

Open-source python package for the extraction of Radiomics features from 2D and 3D images and binary masks. Support: https://discourse.slicer.org/c/community/radiomics

http://pyradiomics.readthedocs.io/

BSD 3-Clause "New" or "Revised" License

1.14k stars 492 forks source link

Migrate documentation for individual functions from the HeterogeneityCAD wiki #3

Closed fedorov closed 8 years ago

fedorov commented 8 years ago

As described in the comments to #2, a lot of functions are thoroughly documented on this page: http://www.slicer.org/slicerWiki/index.php/Documentation/Nightly/Modules/HeterogeneityCAD. These descriptions should be added to the code as docstrings.

fedorov commented 8 years ago

documentation of first order and texture features added in #4

vnarayan13 commented 8 years ago

this has been completed

fedorov commented 8 years ago

@vnarayan13 are you saying all functions are now documented, as well as abbreviations and such?

@naucoin please verify and confirm here.

Thanks

naucoin commented 8 years ago

@fedorov @vnarayan13

firstorder.py - done glszm - done rlgl - done glcm:

[ ] getHomogeneity1FeatureValue and getHomogeneity2FeatureValue have the same comments.
[ ] getImc1FeatureValue, getImc2FeatureValue, getIdmnFeatureValue, getIdnFeatureValue comments don't contain expansions of the acronyms

shape:

[ ] getCompactness1FeatureValue and getCompactness2FeatureValue have the same comments

naucoin commented 8 years ago

@fedorov Pull request that expands acronyms and checks off the list of to-do's above: https://github.com/Radiomics/pyradiomics/pull/54