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

list downsampling methods in docstring of to_multiscale #74

Merged
merged 3 commits into from
Feb 6, 2023

Conversation

giovp
Copy link
Contributor

@giovp giovp commented Feb 2, 2023

This PR improves docstrings to explicitly list downsampling methods used to build the multiscale spatial image. This is the result.

    method : multiscale_spatial_image.Methods, optional
        Method to reduce the input image. Available methods are the following:
    
        - `'xarray_coarsen'` - Use xarray coarsen to downsample the image.
        - `'itk_bin_shrink'` - Use ITK BinShrinkImageFilter to downsample the image.
        - `'itk_gaussian'` - Use ITK GaussianImageFilter to downsample the image.
        - `'itk_label_gaussian'` - Use ITK LabelGaussianImageFilter to downsample the image.
        - `'dask_image_gaussian'` - Use dask-image gaussian_filter to downsample the image.
        - `'dask_image_mode'` - Use dask-image mode_filter to downsample the image.
        - `'dask_image_nearest'` - Use dask-image zoom to downsample the image.

thought it'd be a useful feature for users, please disregard if not in scope.

Copy link
Contributor

@thewtex thewtex left a comment

Choose a reason for hiding this comment

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

Cool, thanks!

from typing import Any, Callable


def inject_docs(**kwargs: Any) -> Callable[..., Any]:
Copy link
Contributor

Choose a reason for hiding this comment

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

neat!

@thewtex thewtex merged commit 7a67eea into spatial-image:main Feb 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants