xarray.Variable.argmax

xarray.Variable.argmax#

Variable.argmax(dim=None, axis=None, keep_attrs=None, skipna=None)[source]#

Index or indices of the maximum of the Variable over one or more dimensions. If a sequence is passed to ‘dim’, then result returned as dict of Variables, which can be passed directly to isel(). If a single str is passed to ‘dim’ then returns a Variable with dtype int.

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

Parameters:
  • dim ("...", str, Iterable of Hashable or None, optional) – The dimensions 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 return a dict with indices for all dimensions; to return a dict with all dimensions now, pass ‘…’.

  • axis (int, optional) – Axis over which to apply argmin. Only one of the ‘dim’ and ‘axis’ arguments can be supplied.

  • 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 (Variable or dict of Variable)