Skip to content

Commit

Permalink
fix confusion with coordinate names and ranges
Browse files Browse the repository at this point in the history
  • Loading branch information
f-brinkmann committed Apr 26, 2024
1 parent 9f3871e commit 04bfd4f
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions pyfar/classes/coordinates.py
Expand Up @@ -50,44 +50,44 @@
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
in radians. :math:`0` radians colatitude 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:`0\leq` colatitude :math:`\leq\pi`). 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
in radians. :math:`0` radians elevation 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:`-\pi/2\leq` elevation :math:`\leq\pi/2`). 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
coordinate system in radians. :math:`0` radians are defined in positive
x-direction, :math:`\pi/2` radians in positive y-direction and
:math:`-\pi/2` in negative y-direction
(:math:`-\pi/2` < lateral < :math:`\pi/2`).
(:math:`-\pi/2\leq` lateral :math:`\leq\pi/2`).
* - :py:func:`~pyfar.classes.coordinates.Coordinates.polar`
- Angle in the x-z plane of the right handed Cartesian coordinate system
in radians. :math:`0` radians elevation are defined in positive
in radians. :math:`0` radians polar angle are defined in positive
x-direction, :math:`\pi/2` radians in positive z-direction,
:math:`\pi` in negative x-direction and so on
(:math:`-\infty` < polar < :math:`\infty`, :math:`2\pi`-cyclic).
* - :py:func:`~pyfar.classes.coordinates.Coordinates.frontal`
- Angle in the y-z plane of the right handed Cartesian coordinate system
in radians. :math:`0` radians elevation are defined in positive
in radians. :math:`0` radians frontal angle are defined in positive
y-direction, :math:`\pi/2` radians in positive z-direction,
:math:`\pi` in negative y-direction and so on
(:math:`-\infty` < frontal < :math:`\infty`, :math:`2\pi`-cyclic).
* - :py:func:`~pyfar.classes.coordinates.Coordinates.upper`
- Angle in the x-z plane of the right handed Cartesian coordinate system
in radians. :math:`0` radians elevation are defined in positive
in radians. :math:`0` radians upper angle are defined in positive
x-direction, :math:`\pi/2` radians in positive z-direction, and
:math:`\pi` in negative x-direction
(:math:`0` < upper < :math:`\pi`).
(:math:`0\leq` upper :math:`\leq\pi`).
* - :py:func:`~pyfar.classes.coordinates.Coordinates.radius`
- Distance to the origin of the right handed Cartesian coordinate system
in meters (:math:`0` < radius < :math:`\infty`).
Expand Down

0 comments on commit 04bfd4f

Please sign in to comment.