nums.numpy.arctan2

nums.numpy.arctan2(x1, x2, out=None, where=True, **kwargs)[source]

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

This docstring was copied from numpy.arctan2.

Some inconsistencies with the NumS version may exist.

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 (x2, x1). (Note the role reversal: the “y-coordinate” is the first function parameter, the “x-coordinate” is the second.) By IEEE convention, this function is defined for x2 = +/-0 and for either or both of x1 and 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.

Parameters

x1 (BlockArray, real-valued) – y-coordinates.
x2 (BlockArray, 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 (BlockArray, None, or 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 (BlockArray, 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.

Returns

angle – Array of angles in radians, in the range [-pi, pi].

Return type

BlockArray

See also

arctan, tan, angle

Notes

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

x1	x2	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.

References

1: ISO/IEC standard 9899:1999, “Programming language C.”

Examples

The doctests shown below are copied from NumPy. They won’t show the correct result until you operate get().

Consider four points in different quadrants:

>>> x = nps.array([-1, +1, +1, -1])  
>>> y = nps.array([-1, -1, +1, +1])  
>>> (nps.arctan2(y, x) * 180 / nps.pi).get()  
array([-135.,  -45.,   45.,  135.])

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

>>> nps.arctan2(nps.array([1., -1.]), nps.array([0., 0.])).get()  
array([ 1.57079633, -1.57079633])
>>> nps.arctan2(nps.array([0., 0., nps.inf]),
...     nps.array([+0., -0., nps.inf])).get()  
array([ 0.        ,  3.14159265,  0.78539816])

nums.numpy.add

nums.numpy.bitwise_and