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.

Sign up for GitHub

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

Document Scaler attributes #418

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Document Scaler attributes #418

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions ome_zarr/scale.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,21 @@ class Scaler:
choices. These values can be returned by the
:func:`~ome_zarr.scale.Scaler.methods` method.

Attributes:
copy_metadata:
If `True`, copy Zarr attributes from the input array to the new group.
downscale:
Downscaling factor.
in_place:
Does not do anything.
labeled:
If `True`, check that the values in the downsampled levels are a subset
of the values found in the input array.
max_layer:
The maximum number of downsampled layers to create.
method:
Downsampling method

>>> import numpy as np
>>> data = np.zeros((1, 1, 1, 64, 64))
>>> scaler = Scaler()
Expand Down
Loading