scipp.max¶

scipp.max(x, dim=None, *, out=None)¶

Element-wise max over the specified dimension or all dimensions if not provided.

Parameters

x (scipp._scipp.core.Variable) – Input data.
dim (Optional[str]) – Optional dimension along which to calculate the max. If not given, the max over all dimensions is calculated.
out (Optional[scipp._scipp.core.Variable]) – Optional output buffer.

Raises

If the dimension does not exist, or the dtype cannot be summed, e.g., if it is a string.

Returns

The max of the input values.

Seealso

scipp.nanmax(), scipp.min().

Return type

scipp._scipp.core.Variable