dask.array.clip — Dask documentation (original) (raw)

Clip (limit) the values in an array.

This docstring was copied from numpy.clip.

Some inconsistencies with the Dask version may exist.

Given an interval, values outside the interval are clipped to the interval edges. For example, if an interval of [0, 1]is specified, values smaller than 0 become 0, and values larger than 1 become 1.

Equivalent to but faster than np.minimum(a_max, np.maximum(a, a_min)).

No check is performed to ensure a_min < a_max.

When a_min is greater than a_max, clip returns an array in which all values are equal to a_max, as shown in the second example.

import numpy as np
a = np.arange(10)
a
array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]) np.clip(a, 1, 8)
array([1, 1, 2, 3, 4, 5, 6, 7, 8, 8]) np.clip(a, 8, 1)
array([1, 1, 1, 1, 1, 1, 1, 1, 1, 1]) np.clip(a, 3, 6, out=a)
array([3, 3, 3, 3, 4, 5, 6, 6, 6, 6]) a
array([3, 3, 3, 3, 4, 5, 6, 6, 6, 6]) a = np.arange(10)
a
array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]) np.clip(a, [3, 4, 1, 1, 1, 4, 4, 4, 4, 4], 8)
array([3, 4, 2, 3, 4, 5, 6, 7, 8, 8])