xarray.Dataset.argmax

Contents

xarray.Dataset.argmax#

Dataset.argmax(dim=None, **kwargs)[source]#

Indices of the maxima of the member variables.

If there are multiple maxima, the indices of the first one found will be returned.

Parameters:

  • dim (str, optional) – The dimension over which to find the maximum. By default, finds maximum over all dimensions - for now returning an int for backward compatibility, but this is deprecated, in future will be an error, since DataArray.argmax will return a dict with indices for all dimensions, which does not make sense for a Dataset.

  • keep_attrs (bool, optional) – If True, the attributes (attrs) will be copied from the original object to the new one. If False (default), the new object will be returned without attributes.

  • skipna (bool, optional) – If True, skip missing values (as marked by NaN). By default, only skips missing values for float dtypes; other dtypes either do not have a sentinel missing value (int) or skipna=True has not been implemented (object, datetime64 or timedelta64).

Returns:

result (Dataset)

Examples

>>> dataset = xr.Dataset(
...     {
...         "math_scores": (
...             ["student", "test"],
...             [[90, 85, 92], [78, 80, 85], [95, 92, 98]],
...         ),
...         "english_scores": (
...             ["student", "test"],
...             [[88, 90, 92], [75, 82, 79], [93, 96, 91]],
...         ),
...     },
...     coords={
...         "student": ["Alice", "Bob", "Charlie"],
...         "test": ["Test 1", "Test 2", "Test 3"],
...     },
... )

# Indices of the maximum values along the ‘student’ dimension are calculated

>>> argmax_indices = dataset.argmax(dim="test")

>>> argmax_indices
<xarray.Dataset> Size: 132B
Dimensions:         (student: 3)
Coordinates:
  * student         (student) <U7 84B 'Alice' 'Bob' 'Charlie'
Data variables:
    math_scores     (student) int64 24B 2 2 2
    english_scores  (student) int64 24B 2 1 1

See also

DataArray.argmax

Contents