Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation terminology for ROI in normalize_roi #595

Open
KedoKudo opened this issue Dec 9, 2022 · 2 comments
Open

Improve documentation terminology for ROI in normalize_roi #595

KedoKudo opened this issue Dec 9, 2022 · 2 comments
Labels
documentation Improve documentation good first issue A simple issue that beginning level contributors can manage help wanted

Comments

@KedoKudo
Copy link
Contributor

KedoKudo commented Dec 9, 2022

Is your feature request related to a problem? Please describe.
The current documentation of normalize_roi is confusing as it refers an integer as pixel coordinates, which should be a tuple for an 2D image.

Describe the solution you would like.
It is better to provide an ASCII art to show case what these four integers actually refers to.

Describe alternatives you've considered.
The alternative would be change the inputs into actual pixel coordinates as a list of [(row, col),... ], however this API change would probably break a lot of downstream code depending on Tomopy.

Additional context.
N/A

@KedoKudo KedoKudo added the feature request Feature requests or discussions label Dec 9, 2022
@KedoKudo
Copy link
Contributor Author

KedoKudo commented Dec 9, 2022

@JeanBilheux

@carterbox
Copy link
Member

def normalize_roi(arr, roi=[0, 0, 10, 10], ncore=None):

@carterbox carterbox added good first issue A simple issue that beginning level contributors can manage help wanted documentation Improve documentation and removed feature request Feature requests or discussions labels Dec 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve documentation good first issue A simple issue that beginning level contributors can manage help wanted
Projects
None yet
Development

No branches or pull requests

2 participants