Skip to content
This is an archived version of the documentation downloaded from LogScale Documentation Archives. Up to date documentation, and documentation for later versions, is available on LogScale Documentation

## `math:arctan2()`

Calculates the angle in radians from the positive x-axis to the point (x, y) in the plane.

### Note

Math functions on ARM architecture may return different results in very high-precision calculationsc compared to Intel/AMD architectures.

Parameter | Type | Required | Default Value | Description
--- | --- | --- | --- | ---
`as` | string | optional[a] | `_arctan2` | The name of the output field.
`x` | string | required |  | The x-coordinate.
`y` | string | required |  | The y-coordinate.
[a] Optional parameters use their default value unless explicitly set.

### `math:arctan2()` Examples

Click + next to an example below to get the full details.

#### Calculate Angle From Coordinates

Calculate the angle to a point using the `math:arctan2()` function

##### Query

logscale

    x := 1.0
    y := 1.0
    | math:arctan2(y=y, x=x, as=angle)

##### Introduction

In this example, the `math:arctan2()` function is used to calculate the angle to a point on a coordinate graph where both `x` and `y` equal `1.0`, similar to finding the angle of a line drawn from the center (0,0) to a point on a graph paper.

##### Step-by-Step

1. Starting with the source repository events.

2. logscale

       x := 1.0
       y := 1.0

   Assigns the coordinates (`1.0`, `1.0`) to the fields x and y. This point lies at `45` degrees (π/4 radians) from the positive x-axis.

3. logscale

       | math:arctan2(y=y, x=x, as=angle)

   Calculates the angle in radians from the positive x-axis to the point (x, y) and returns the result in a field named angle. If the `as` parameter is not specified, the result is returned in a field named _arctan2 as default.

4. Event Result set.

##### Summary and Results

The query is used to calculate the angle to a point in a 2D plane, which is essential in various geometric calculations, direction finding, and vector operations.

This query is useful, for example, to determine directions in navigation systems, calculate angles in geometric applications, or analyze circular motion patterns.

Sample output from the incoming example data:

angle
0.7853981633974483

The result shows that the angle to the point (1.0, 1.0) is approximately 0.7854 radians (π/4 radians or 45 degrees). The `math:arctan2()` function returns angles in the range -π to π radians, with positive angles measured counterclockwise from the x-axis.

Note that `math:arctan2()` differs from regular arctangent by considering the quadrant of the point, using both x and y coordinates to determine the correct angle. For example, points (1,1) and (-1,-1) have the same arctangent but different arctan2 values (π/4 and -3π/4 respectively).

#### Enter search term