Skip to content

Commit

Permalink
Document Scaler attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
dstansby committed Dec 28, 2024
1 parent 6ac9989 commit 4e319db
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions ome_zarr/scale.py
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

0 comments on commit 4e319db

Please sign in to comment.