# xarray.ufuncs.heaviside

### xarray.ufuncs.heaviside *= <xarray.ufuncs._binary_ufunc object>*

xarray specific variant of `numpy.heaviside()`. Handles xarray objects by dispatching to the appropriate function for the underlying array type.

Documentation from numpy:

Compute the Heaviside step function.

The Heaviside step function <sup>[1](#id2)</sup> is defined as:

```default
                      0   if x1 < 0
heaviside(x1, x2) =  x2   if x1 == 0
                      1   if x1 > 0
```

where x2 is often taken to be 0.5, but 0 and 1 are also sometimes used.

* **Parameters:**
  * **x1** ([array_like](https://numpy.org/doc/stable/glossary.html#term-array_like)) – Input values.
  * **x2** ([array_like](https://numpy.org/doc/stable/glossary.html#term-array_like)) – The value of the function when x1 is 0.
    If `x1.shape != x2.shape`, they must be broadcastable to a common
    shape (which becomes the shape of the output).
  * **out** ([`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray), [`None`](https://docs.python.org/3/builtins/constants.html#None), or [`tuple`](https://docs.python.org/3/builtins/stdtypes.html#tuple) of [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray) and [`None`](https://docs.python.org/3/builtins/constants.html#None), *optional*) – A location into which the result is stored. If provided, it must have
    a shape that the inputs broadcast to. If not provided or None,
    a freshly-allocated array is returned. A tuple (possible only as a
    keyword argument) must have length equal to the number of outputs.
  * **where** ([array_like](https://numpy.org/doc/stable/glossary.html#term-array_like), *optional*) – This condition is broadcast over the input. At locations where the
    condition is True, the out array will be set to the ufunc result.
    Elsewhere, the out array will retain its original value.
    Note that if an uninitialized out array is created via the default
    `out=None`, locations within it where the condition is False will
    remain uninitialized.
  * **\*\*kwargs** – For other keyword-only arguments, see the
    [ufunc docs](https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs).
* **Returns:**
  **out** ([`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray) or [scalar](../user-guide/terminology.html.md#term-scalar)) – The output array, element-wise Heaviside step function of x1.
  This is a scalar if both x1 and x2 are scalars.

### References

* <a id='id2'>**[1]**</a> Wikipedia, “Heaviside step function”, [https://en.wikipedia.org/wiki/Heaviside_step_function](https://en.wikipedia.org/wiki/Heaviside_step_function)

### Examples

<div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesShowIframe('30d1f603-4ff6-4691-a97d-4190e24177da','4128f6e3-3451-4b96-9bd8-4f9db195e733','3296b533-9720-4b4d-9df7-8cba56f75f5c','../lite/tree/../notebooks/index.html?path=9f1b2ebd_18be_4ba6_8a34_a3d3cf069b17.ipynb','None')">Try it in your browser!</button></div>
```pycon
>>> import numpy as np
>>> np.heaviside([-1.5, 0, 2.0], 0.5)
array([ 0. ,  0.5,  1. ])
>>> np.heaviside([-1.5, 0, 2.0], 1)
array([ 0.,  1.,  1.])
```

<div id="3296b533-9720-4b4d-9df7-8cba56f75f5c" class="try_examples_outer_iframe  hidden"><div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesHideIframe('30d1f603-4ff6-4691-a97d-4190e24177da','3296b533-9720-4b4d-9df7-8cba56f75f5c')">Go Back</button><button class="try_examples_button" onclick="window.openInNewTab('30d1f603-4ff6-4691-a97d-4190e24177da','3296b533-9720-4b4d-9df7-8cba56f75f5c')">Open In Tab</button></div><div id="4128f6e3-3451-4b96-9bd8-4f9db195e733" class="jupyterlite_sphinx_iframe_container"></div></div><script>document.addEventListener("DOMContentLoaded", function() {window.loadTryExamplesConfig("../try_examples.json");});</script>