Update documentation in base.py #306
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fedorov
approved these changes
Oct 6, 2017
radiomics/base.py
Outdated
| - matrixCoordinates: tuple of 3 numpy arrays containing the z, x and y coordinates of the voxels included in the ROI, | ||
| respectively. Length of each array is equal to total number of voxels inside ROI. | ||
| - targetVoxelArray: flattened numpy array of gray values inside ROI. | ||
| - inputImage: Simple ITK image object of the input image (dimensions x, y, z) |
There was a problem hiding this comment.
I would replace all occurrences of "Simple ITK" with "SimpleITK"
JoostJM
force-pushed
the
update-base-docs
branch
from
1224dcb
to
cbdefdf
Compare
Clarify that variables mentioned in the base class are variables instantiated by the base class, not possible settings for customization (also add redirect to customization documentation). Update the documentation to reflect changes made to the structure of the base class, more specifically the initialization of a feature class. Add documentation for the "Label" parameter to the customization documentation.
JoostJM
force-pushed
the
update-base-docs
branch
from
cbdefdf
to
0acccfe
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clarify that variables mentioned in the base class are variables instantiated by the base class, not possible settings for customization (also add redirect to customization documentation).
Update the documentation to reflect changes made to the structure of the base class, more specifically the initialization of a feature class.
Add documentation for the "Label" parameter to the customization documentation.
cc @Radiomics/developers