[DOC] clarify that the inertia_tensor may be nD in documentation #4013
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
alexdesiqueira
suggested changes
Jul 13, 2019
There was a problem hiding this comment.
Thank you very much for tackling this, @marshuang80! I left some comments already 😅
skimage/measure/_regionprops.py
Outdated
| @@ -657,10 +657,10 @@ def regionprops(label_image, intensity_image=None, cache=True): | |||
| bounding box. | |||
| **image** : (H, J) ndarray | |||
| Sliced binary region image which has the same size as bounding box. | |||
| **inertia_tensor** : (2, 2) ndarray | |||
| **inertia_tensor** : (Ndim, Ndim) ndarray | |||
There was a problem hiding this comment.
I think only mentioning this as ndarray should be sufficient:
**inertia_tensor** : ndarray
skimage/measure/_regionprops.py
Outdated
| Inertia tensor of the region for the rotation around its mass. | ||
| **inertia_tensor_eigvals** : tuple | ||
| The two eigen values of the inertia tensor in decreasing order. | ||
| The N eigen values of the inertia tensor in decreasing order. |
There was a problem hiding this comment.
The N here is not necessary. It could be:
The eigenvalues of the inertia tensor in decreasing order.
alexdesiqueira
approved these changes
Jul 13, 2019
hmaarrfk
changed the title
|
Thanks! |
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.
Description
Fixed import issue and documentation for inertia_tensor #4004
Checklist
For reviewers
later.
__init__.py.doc/release/release_dev.rst.@meeseeksdev backport to v0.14.x