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

Fix some typing and docstring issues #223

Merged
merged 5 commits into from
Feb 13, 2022
Merged

Fix some typing and docstring issues #223

merged 5 commits into from
Feb 13, 2022

Conversation

bwohlberg
Copy link
Collaborator

Fix some typing and docstring issues.

@bwohlberg bwohlberg added documentation Improvements or additions to documentation standards Coding standards issues or violations labels Feb 12, 2022
@bwohlberg bwohlberg requested a review from smajee February 12, 2022 00:08
"""

if center == None:
if center is None:
center = [img_dim // 2 for img_dim in img_shape]
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the intent here really to only support integer center values? If not, this should be ... img_dim / 2 ....

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I originally thought of only integer values. But making it floats (/ instead of //) would be more general and should work.

img_shape: Shape of the phantom to be created.
radius_list: List of radii of the rings in the phantom.
val_list: List of intensity values of the rings in the phantom.
center: Tuple of center pixel ids. If ``None``, this is set to
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are "ids" in "center pixel ids"? Perhaps this was intended to be "center pixel indices"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, by ids I meant indices.

@codecov
Copy link

codecov bot commented Feb 12, 2022

Codecov Report

Merging #223 (85c579c) into main (b2cfe33) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #223   +/-   ##
=======================================
  Coverage   92.42%   92.42%           
=======================================
  Files          49       49           
  Lines        3431     3431           
=======================================
  Hits         3171     3171           
  Misses        260      260           
Flag Coverage Δ
unittests 92.42% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
scico/examples.py 94.36% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b2cfe33...85c579c. Read the comment docs.

Copy link
Contributor

@smajee smajee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@bwohlberg bwohlberg merged commit d5dddee into main Feb 13, 2022
@bwohlberg bwohlberg deleted the brendt/examples branch February 13, 2022 01:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation standards Coding standards issues or violations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants