dask 2021.10.0

NotesParametersReturnsBackRef
arctan2(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])

Some inconsistencies with the Dask version may exist.

Element-wise arc tangent of x1/x2 choosing the quadrant correctly.

The quadrant (i.e., branch) is chosen so that arctan2(x1, x2) is the signed angle in radians between the ray ending at the origin and passing through the point (1,0), and the ray ending at the origin and passing through the point (:None:None:`x2`, :None:None:`x1`). (Note the role reversal: the ":None:None:`y`-coordinate" is the first function parameter, the "x-coordinate" is the second.) By IEEE convention, this function is defined for :None:None:`x2` = +/-0 and for either or both of :None:None:`x1` and :None:None:`x2` = +/-inf (see Notes for specific values).

This function is not defined for complex-valued arguments; for the so-called argument of complex values, use angle .

Notes

arctan2 is identical to the :None:None:`atan2` function of the underlying C library. The following special values are defined in the C standard:

====== ====== ================ :None:None:`x1` :None:None:`x2` :None:None:`arctan2(x1,x2)` ====== ====== ================ +/- 0 +0 +/- 0 +/- 0 -0 +/- pi > 0 +/-inf +0 / +pi < 0 +/-inf -0 / -pi +/-inf +inf +/- (pi/4) +/-inf -inf +/- (3*pi/4) ====== ====== ================

Note that +0 and -0 are distinct floating point numbers, as are +inf and -inf.

Parameters

x1 : array_like, real-valued

:None:None:`y`-coordinates.

x2 : array_like, real-valued

x-coordinates. If x1.shape != x2.shape , they must be broadcastable to a common shape (which becomes the shape of the output).

out : ndarray, None, or tuple of ndarray and 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, optional

This condition is broadcast over the input. At locations where the condition is True, the :None:None:`out` array will be set to the ufunc result. Elsewhere, the :None:None:`out` array will retain its original value. Note that if an uninitialized :None:None:`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 <ufuncs.kwargs> .

Returns

angle : ndarray

Array of angles in radians, in the range [-pi, pi] . This is a scalar if both :None:None:`x1` and :None:None:`x2` are scalars.

This docstring was copied from numpy.arctan2.

See Also

angle
arctan
tan

Examples

Consider four points in different quadrants:

This example is valid syntax, but we were not able to check execution
>>> x = np.array([-1, +1, +1, -1])  # doctest: +SKIP
... y = np.array([-1, -1, +1, +1]) # doctest: +SKIP
... np.arctan2(y, x) * 180 / np.pi # doctest: +SKIP array([-135., -45., 45., 135.])

Note the order of the parameters. arctan2 is defined also when :None:None:`x2` = 0 and at several other special points, obtaining values in the range [-pi, pi] :

This example is valid syntax, but we were not able to check execution
>>> np.arctan2([1., -1.], [0., 0.])  # doctest: +SKIP
array([ 1.57079633, -1.57079633])
This example is valid syntax, but we were not able to check execution
>>> np.arctan2([0., 0., np.inf], [+0., -0., np.inf])  # doctest: +SKIP
array([ 0.        ,  3.14159265,  0.78539816])
See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

dask.array.ufunc.arctan2 dask.array.ufunc.arcsin dask.array.ufunc.arctan dask.array.ufunc.angle

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /dask/array/ufunc.py#None
type: <class 'dask.array.ufunc.ufunc'>
Commit: