scipp.max#

scipp.max(x, dim=None)#

Maximum of elements in the input.

Warning

Scipp returns DBL_MIN or INT_MIN for empty inputs of float or int dtype, respectively, while NumPy raises. Note that in the case of DataArray, inputs can also be “empty” if all elements contributing to an output element are masked.

Parameters:
  • x (scipp.typing.VariableLike) – Input data.

  • dim (Optional[str], default: None) – Optional dimension along which to calculate the max. If not given, the max over all dimensions is calculated.

Returns:

TypeVar(VariableLikeType, Variable, DataArray, Dataset, DataGroup[Any]) – The maximum of the input values.

See also

scipp.min

Element-wise minimum.

scipp.nanmin

Same as min but ignoring NaN’s.

scipp.nanmax

Same as max but ignoring NaN’s.