{ } Raw JSON

bundles / scipy 1.17.1 / scipy / special / _multiufuncs / sph_harm_y

MultiUFunc

scipy.special._multiufuncs:sph_harm_y

source: /scipy/special/_multiufuncs.py

Signature

def   sph_harm_y ( n m theta phi * diff_n = 0 )

Summary

Spherical harmonics. They are defined as

Extended Summary

where are the (unnormalized) associated Legendre polynomials.

Parameters

n : ArrayLike[int]

Degree of the harmonic. Must have n >= 0. This is often denoted by l (lower case L) in descriptions of spherical harmonics.

m : ArrayLike[int]

Order of the harmonic.

theta : ArrayLike[float]

Polar (colatitudinal) coordinate; must be in [0, pi].

phi : ArrayLike[float]

Azimuthal (longitudinal) coordinate; must be in [0, 2*pi].

diff_n : Optional[int]

A non-negative integer. Compute and return all derivatives up to order diff_n. Default is 0.

Returns

y : ndarray[complex] or tuple[ndarray[complex]]

Spherical harmonics with diff_n derivatives.

Notes

There are different conventions for the meanings of the input arguments theta and phi. In SciPy theta is the polar angle and phi is the azimuthal angle. It is common to see the opposite convention, that is, theta as the azimuthal angle and phi as the polar angle.

Note that SciPy's spherical harmonics include the Condon-Shortley phase [2] because it is part of sph_legendre_p.

With SciPy's conventions, the first several spherical harmonics are

Aliases

  • scipy.special.sph_harm_y

Referenced by

This package