Reduce this DataArray's data by applying ``std`` along some dimension(s). Parameters ---------- dim : str, Iterable of Hashable, "..." or None, default: None Name of dimension[s] along which to apply ``std``. For e.g. ``dim="x"`` or ``dim=["x
(
self,
dim: Dims = None,
*,
skipna: bool | None = None,
ddof: int = 0,
keep_attrs: bool | None = None,
**kwargs: Any,
)
| 7660 | return out |
| 7661 | |
| 7662 | def std( |
| 7663 | self, |
| 7664 | dim: Dims = None, |
| 7665 | *, |
| 7666 | skipna: bool | None = None, |
| 7667 | ddof: int = 0, |
| 7668 | keep_attrs: bool | None = None, |
| 7669 | **kwargs: Any, |
| 7670 | ) -> DataArray: |
| 7671 | """ |
| 7672 | Reduce this DataArray's data by applying ``std`` along some dimension(s). |
| 7673 | |
| 7674 | Parameters |
| 7675 | ---------- |
| 7676 | dim : str, Iterable of Hashable, "..." or None, default: None |
| 7677 | Name of dimension[s] along which to apply ``std``. For e.g. ``dim="x"`` |
| 7678 | or ``dim=["x", "y"]``. If None, will reduce over the GroupBy dimensions. |
| 7679 | If "...", will reduce over all dimensions. |
| 7680 | skipna : bool or None, optional |
| 7681 | If True, skip missing values (as marked by NaN). By default, only |
| 7682 | skips missing values for float dtypes; other dtypes either do not |
| 7683 | have a sentinel missing value (int) or ``skipna=True`` has not been |
| 7684 | implemented (object, datetime64 or timedelta64). |
| 7685 | ddof : int, default: 0 |
| 7686 | “Delta Degrees of Freedom”: the divisor used in the calculation is ``N - ddof``, |
| 7687 | where ``N`` represents the number of elements. |
| 7688 | keep_attrs : bool or None, optional |
| 7689 | If True, ``attrs`` will be copied from the original |
| 7690 | object to the new one. If False, the new object will be |
| 7691 | returned without attributes. |
| 7692 | **kwargs : Any |
| 7693 | Additional keyword arguments passed on to the appropriate array |
| 7694 | function for calculating ``std`` on this object's data. |
| 7695 | These could include dask-specific kwargs like ``split_every``. |
| 7696 | |
| 7697 | Returns |
| 7698 | ------- |
| 7699 | reduced : DataArray |
| 7700 | New DataArray with ``std`` applied to its data and the |
| 7701 | indicated dimension(s) removed |
| 7702 | |
| 7703 | See Also |
| 7704 | -------- |
| 7705 | numpy.std |
| 7706 | dask.array.std |
| 7707 | DataArray.std |
| 7708 | :ref:`groupby` |
| 7709 | User guide on groupby operations. |
| 7710 | |
| 7711 | Notes |
| 7712 | ----- |
| 7713 | Use the ``flox`` package to significantly speed up groupby computations, |
| 7714 | especially with dask arrays. Xarray will use flox by default if installed. |
| 7715 | Pass flox-specific keyword arguments in ``**kwargs``. |
| 7716 | See the `flox documentation <https://flox.readthedocs.io>`_ for more. |
| 7717 | |
| 7718 | Non-numeric variables will be removed prior to reducing. |
| 7719 |
nothing calls this directly
no test coverage detected