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

What should be in the abel namespace? #379

Open
MikhailRyazanov opened this issue Nov 10, 2023 · 0 comments
Open

What should be in the abel namespace? #379

MikhailRyazanov opened this issue Nov 10, 2023 · 0 comments

Comments

@MikhailRyazanov
Copy link
Collaborator

Let's discuss the issue raised in #378. Namely, abel/__init__.py imports

from .transform import Transform
from .tools.center import center_image

so that users can call the short forms abel.Transform and abel.center_image, without specifying corresponding submodules.
I guess, everybody agrees that abel.Transform is desirable, as it gives the simplest unified access to basic functionality, but the opinions regarding abel.center_image were different. Moreover, the latter wasn't documented anywhere.

So the question is whether we should leave/recommend only abel.Transform and deprecate abel.center_image (to be removed completely later), or to document abel.center_image and recommend it for basic tasks. If we incline towards the second option, then it might be also a good idea to add

from .tools.circularize import circularize_image

because it's also quite useful (sometimes even necessary) in practice and, unlike center_image, is not available through Transform options.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant