× ⚠️ You are reading the development version documentation.
Read here the documentation of the last stable release.

spectrochempy.amax

amax(dataset, dim=None, keepdims=False, **kwargs)

Return the maximum of the dataset or maxima along given dimensions.

Parameters:

• dataset (array_like) – Input array or object that can be converted to an array.

• dim (None or int or dimension name or tuple of int or dimensions, optional) – Dimension or dimensions along which to operate. By default, flattened input is used. If this is a tuple, the maximum is selected over multiple dimensions, instead of a single dimension or all the dimensions as before.

• keepdims (bool, optional) – If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the input array.

Returns:

amax – Maximum of the data. If dim is None, the result is a scalar value. If dim is given, the result is an array of dimension ndim - 1 .

See also

amin

The minimum value of a dataset along a given dimension, propagating NaNs.

minimum

Element-wise minimum of two datasets, propagating any NaNs.

maximum

Element-wise maximum of two datasets, propagating any NaNs.

fmax

Element-wise maximum of two datasets, ignoring any NaNs.

fmin

Element-wise minimum of two datasets, ignoring any NaNs.

argmax

Return the indices or coordinates of the maximum values.

argmin

Return the indices or coordinates of the minimum values.

Notes

For dataset with complex or hypercomplex type type, the default is the value with the maximum real part.