Skip to content

docs(space_ops): correct cartesian_to_spherical return order #4856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Chessing234 wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −1
Open

docs(space_ops): correct cartesian_to_spherical return order #4856

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion manim/utils/space_ops.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -810,12 +810,24 @@ def earclip_triangulation(verts: np.ndarray, ring_ends: list) -> list:

def cartesian_to_spherical(vec: Vector3DLike) -> np.ndarray:
"""Returns an array of numbers corresponding to each
polar coordinate value (distance, phi, theta).
spherical coordinate value ``(r, theta, phi)``.

This is the inverse of :func:`spherical_to_cartesian` and uses the same
coordinate order, so the two functions round-trip.

Parameters
----------
vec
A numpy array or a sequence of floats ``[x, y, z]``.

Returns
-------
np.ndarray
A numpy array ``[r, theta, phi]`` where:

* ``r`` is the distance between the point and the origin.
* ``theta`` is the azimuthal angle to the positive x-axis.
* ``phi`` is the vertical angle to the positive z-axis.
"""
norm = np.linalg.norm(vec)
if norm == 0:
Expand Down
Loading