Skip to content

Commit

Permalink
fix confusion in elevation and colatitude
Browse files Browse the repository at this point in the history
  • Loading branch information
f-brinkmann committed Apr 26, 2024
1 parent 9f3871e commit c6917c4
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions pyfar/classes/coordinates.py
Expand Up @@ -50,19 +50,19 @@
coordinate system in radians. :math:`0` radians are defined in positive
x-direction, :math:`\pi/2` radians in positive y-direction and so on
(:math:`-\infty` < azimuth < :math:`\infty`, :math:`2\pi`-cyclic).
* - :py:func:`~pyfar.classes.coordinates.Coordinates.elevation`
* - :py:func:`~pyfar.classes.coordinates.Coordinates.colatitude`
- Angle in the x-z plane of the right handed Cartesian coordinate system
in radians. :math:`0` radians elevation are defined in positive
z-direction, :math:`\pi/2` radians in positive x-direction, and
:math:`\pi` in negative z-direction
(:math:`\pi/2` < elevation < :math:`\pi/2`). The elevation is a
(:math:`\pi/2` < elevation < :math:`\pi/2`). The colatitude is a
variation of the elevation angle.
* - :py:func:`~pyfar.classes.coordinates.Coordinates.colatitude`
* - :py:func:`~pyfar.classes.coordinates.Coordinates.elevation`
- Angle in the x-z plane of the right handed Cartesian coordinate system
in radians. :math:`0` radians colatitude are defined in positive
x-direction, :math:`\pi/2` radians in positive z-direction, and
:math:`-\pi/2` in negative z-direction
(:math:`0` < colatitude < :math:`\pi`). The colatitude is a
(:math:`0` < colatitude < :math:`\pi`). The elevation is a
variation of the colatitude.
* - :py:func:`~pyfar.classes.coordinates.Coordinates.lateral`
- Counter clock-wise angle in the x-y plane of the right handed Cartesian
Expand Down

0 comments on commit c6917c4

Please sign in to comment.