-
Notifications
You must be signed in to change notification settings - Fork 61
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
Img proc math #289
Img proc math #289
Conversation
Input types were assigned as either array-like or array_like. Any input type that was specified as array_like has now been changed to array-like for consistency.
In an effort to simplify the user experience for image processing, image processing folders and modules are being refactored to more clearly state what kind of tools each module contains. This initial refactor specifically changes the folder name: skxray/img_proc to skxray/image_processing and the module mathops.py to arithmetic.py. This also addresses a long standing question from Tom about why I was beholden to the name mathops (which stood for math operations). I'm hoping that these changes add an additional level of clarity.
This needs a note in https://github.com/Nikea/scikit-xray/tree/master/doc/api_changes documenting the API change. |
Probably have to update setup.py as well. On Sun, Jun 21, 2015 at 7:04 AM Gabriel Iltis notifications@github.com
|
I would also advocate for turning |
Documented the renaming of folder img_proc to image_processing, and renaming of module mathops.py to arithmetic.py. These changes were made in order to help clarify function and tool groups for users.
@ericdill : So you're thinking of simply including a package called 'image' instead of 'image processing' ? |
@danielballan : There is a very real possibility that I'm missing something here, but I'm not seeing where, or why a change to setup.py should be made. |
But there is a module called 'image.py' already in skxray? It has some image processing tools too, (@tacaswell finding the center of the ring). May be, you can integrate everything into image package? |
All of the modules in skxray/ (
|
re: setup.py. As the setup.py file of skxray is currently written, there is no need to change it (https://github.com/Nikea/scikit-xray/blob/master/setup.py#L21). What @danielballan is likely referring to is how setup.py is done in many of our other libraries (see dataportal, for example https://github.com/NSLS-II/dataportal/blob/master/setup.py#L65) where we are explicitly listing each and every subpackage in the library. Because you added a new subpackage |
API: re-arrange some of the image processing tools
Minor docstring correction and organizational refactor. Finally changing module name from mathops to more clearly understandable name of arithmetic