diff --git a/functions/africa.html b/functions/africa.html index 32b2acdf..273305ff 100644 --- a/functions/africa.html +++ b/functions/africa.html @@ -3,13 +3,13 @@ - + sleplet.functions.africa API documentation - + @@ -110,7 +110,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/axisymmetric_wavelet_coefficients_africa.html b/functions/axisymmetric_wavelet_coefficients_africa.html index 27e8e1c9..d432d88a 100644 --- a/functions/axisymmetric_wavelet_coefficients_africa.html +++ b/functions/axisymmetric_wavelet_coefficients_africa.html @@ -3,13 +3,13 @@ - + sleplet.functions.axisymmetric_wavelet_coefficients_africa API documentation - + @@ -125,7 +125,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/axisymmetric_wavelet_coefficients_earth.html b/functions/axisymmetric_wavelet_coefficients_earth.html index 2d4f43a5..6f8bc0e1 100644 --- a/functions/axisymmetric_wavelet_coefficients_earth.html +++ b/functions/axisymmetric_wavelet_coefficients_earth.html @@ -3,13 +3,13 @@ - + sleplet.functions.axisymmetric_wavelet_coefficients_earth API documentation - + @@ -125,7 +125,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/axisymmetric_wavelet_coefficients_south_america.html b/functions/axisymmetric_wavelet_coefficients_south_america.html index 0b4a25e9..3427dc2e 100644 --- a/functions/axisymmetric_wavelet_coefficients_south_america.html +++ b/functions/axisymmetric_wavelet_coefficients_south_america.html @@ -3,13 +3,13 @@ - + sleplet.functions.axisymmetric_wavelet_coefficients_south_america API documentation - + @@ -125,7 +125,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/axisymmetric_wavelets.html b/functions/axisymmetric_wavelets.html index 5977e4dc..933975cd 100644 --- a/functions/axisymmetric_wavelets.html +++ b/functions/axisymmetric_wavelets.html @@ -3,13 +3,13 @@ - + sleplet.functions.axisymmetric_wavelets API documentation - + @@ -126,7 +126,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/coefficients.html b/functions/coefficients.html index a120f5ee..aff53c88 100644 --- a/functions/coefficients.html +++ b/functions/coefficients.html @@ -3,13 +3,13 @@ - + sleplet.functions.coefficients API documentation - + @@ -105,7 +105,7 @@

Class variables

Methods

-def convolve(self: Self, f_coefficient: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], g_coefficient: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], *, shannon: int | None = None) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] +def convolve(self: Self,
f_coefficient: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
g_coefficient: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
*,
shannon: int | None = None) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

Perform the sifting convolution of the two inputs.

@@ -198,7 +198,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/dirac_delta.html b/functions/dirac_delta.html index 2b96778a..a6407adc 100644 --- a/functions/dirac_delta.html +++ b/functions/dirac_delta.html @@ -3,13 +3,13 @@ - + sleplet.functions.dirac_delta API documentation - + @@ -109,7 +109,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/earth.html b/functions/earth.html index 4f70920f..ed95f615 100644 --- a/functions/earth.html +++ b/functions/earth.html @@ -3,13 +3,13 @@ - + sleplet.functions.earth API documentation - + @@ -109,7 +109,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/elongated_gaussian.html b/functions/elongated_gaussian.html index 294caeb3..6a50565e 100644 --- a/functions/elongated_gaussian.html +++ b/functions/elongated_gaussian.html @@ -3,13 +3,13 @@ - + sleplet.functions.elongated_gaussian API documentation - + @@ -122,7 +122,7 @@

diff --git a/functions/flm.html b/functions/flm.html index d11f6826..a294dcbd 100644 --- a/functions/flm.html +++ b/functions/flm.html @@ -3,13 +3,13 @@ - + sleplet.functions.flm API documentation - + @@ -128,7 +128,7 @@

diff --git a/functions/fp.html b/functions/fp.html index 3316c023..a735fcce 100644 --- a/functions/fp.html +++ b/functions/fp.html @@ -3,13 +3,13 @@ - + sleplet.functions.fp API documentation - + @@ -126,7 +126,7 @@

Fp< diff --git a/functions/gaussian.html b/functions/gaussian.html index 9e87eb74..aa5fbb71 100644 --- a/functions/gaussian.html +++ b/functions/gaussian.html @@ -3,13 +3,13 @@ - + sleplet.functions.gaussian API documentation - + @@ -114,7 +114,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/harmonic_gaussian.html b/functions/harmonic_gaussian.html index 786b3081..3cea6395 100644 --- a/functions/harmonic_gaussian.html +++ b/functions/harmonic_gaussian.html @@ -3,13 +3,13 @@ - + sleplet.functions.harmonic_gaussian API documentation - + @@ -122,7 +122,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/identity.html b/functions/identity.html index cc56ed81..47426794 100644 --- a/functions/identity.html +++ b/functions/identity.html @@ -3,13 +3,13 @@ - + sleplet.functions.identity API documentation - + @@ -109,7 +109,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/index.html b/functions/index.html index 53383659..a08720d5 100644 --- a/functions/index.html +++ b/functions/index.html @@ -3,13 +3,13 @@ - + sleplet.functions API documentation - + @@ -1784,7 +1784,7 @@

Wmap< diff --git a/functions/noise_earth.html b/functions/noise_earth.html index bd6b99ff..08ba5588 100644 --- a/functions/noise_earth.html +++ b/functions/noise_earth.html @@ -3,13 +3,13 @@ - + sleplet.functions.noise_earth API documentation - + @@ -115,7 +115,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/ridgelets.html b/functions/ridgelets.html index 5d8a17ac..322c29ee 100644 --- a/functions/ridgelets.html +++ b/functions/ridgelets.html @@ -3,13 +3,13 @@ - + sleplet.functions.ridgelets API documentation - + @@ -131,7 +131,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/slepian.html b/functions/slepian.html index 933c2d8d..df10acf1 100644 --- a/functions/slepian.html +++ b/functions/slepian.html @@ -3,13 +3,13 @@ - + sleplet.functions.slepian API documentation - + @@ -115,7 +115,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/slepian_africa.html b/functions/slepian_africa.html index 3ab5ff9f..35c7cf63 100644 --- a/functions/slepian_africa.html +++ b/functions/slepian_africa.html @@ -3,13 +3,13 @@ - + sleplet.functions.slepian_africa API documentation - + @@ -110,7 +110,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/slepian_dirac_delta.html b/functions/slepian_dirac_delta.html index 867d8ae8..109c107a 100644 --- a/functions/slepian_dirac_delta.html +++ b/functions/slepian_dirac_delta.html @@ -3,13 +3,13 @@ - + sleplet.functions.slepian_dirac_delta API documentation - + @@ -109,7 +109,7 @@

diff --git a/functions/slepian_identity.html b/functions/slepian_identity.html index f91545ac..c6ab0de2 100644 --- a/functions/slepian_identity.html +++ b/functions/slepian_identity.html @@ -3,13 +3,13 @@ - + sleplet.functions.slepian_identity API documentation - + @@ -109,7 +109,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/slepian_noise_africa.html b/functions/slepian_noise_africa.html index 8644c898..18ac972e 100644 --- a/functions/slepian_noise_africa.html +++ b/functions/slepian_noise_africa.html @@ -3,13 +3,13 @@ - + sleplet.functions.slepian_noise_africa API documentation - + @@ -116,7 +116,7 @@

diff --git a/functions/slepian_noise_south_america.html b/functions/slepian_noise_south_america.html index 15fd342b..22f017bc 100644 --- a/functions/slepian_noise_south_america.html +++ b/functions/slepian_noise_south_america.html @@ -3,13 +3,13 @@ - + sleplet.functions.slepian_noise_south_america API documentation - + @@ -116,7 +116,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/slepian_south_america.html b/functions/slepian_south_america.html index 4f89085e..fa757b92 100644 --- a/functions/slepian_south_america.html +++ b/functions/slepian_south_america.html @@ -3,13 +3,13 @@ - + sleplet.functions.slepian_south_america API documentation - + @@ -110,7 +110,7 @@

diff --git a/functions/slepian_wavelet_coefficients_africa.html b/functions/slepian_wavelet_coefficients_africa.html index 7a4eb425..8bfc36a3 100644 --- a/functions/slepian_wavelet_coefficients_africa.html +++ b/functions/slepian_wavelet_coefficients_africa.html @@ -3,13 +3,13 @@ - + sleplet.functions.slepian_wavelet_coefficients_africa API documentation - + @@ -125,7 +125,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/slepian_wavelet_coefficients_south_america.html b/functions/slepian_wavelet_coefficients_south_america.html index 418ff462..bb962dbf 100644 --- a/functions/slepian_wavelet_coefficients_south_america.html +++ b/functions/slepian_wavelet_coefficients_south_america.html @@ -3,13 +3,13 @@ - + sleplet.functions.slepian_wavelet_coefficients_south_america API documentation - + @@ -125,7 +125,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/slepian_wavelets.html b/functions/slepian_wavelets.html index 5a27e8fc..24a2417f 100644 --- a/functions/slepian_wavelets.html +++ b/functions/slepian_wavelets.html @@ -3,13 +3,13 @@ - + sleplet.functions.slepian_wavelets API documentation - + @@ -125,7 +125,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/south_america.html b/functions/south_america.html index 6ee9f578..76fdd29b 100644 --- a/functions/south_america.html +++ b/functions/south_america.html @@ -3,13 +3,13 @@ - + sleplet.functions.south_america API documentation - + @@ -109,7 +109,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/spherical_harmonic.html b/functions/spherical_harmonic.html index 4058fd78..bfc60d4b 100644 --- a/functions/spherical_harmonic.html +++ b/functions/spherical_harmonic.html @@ -3,13 +3,13 @@ - + sleplet.functions.spherical_harmonic API documentation - + @@ -119,7 +119,7 @@

diff --git a/functions/squashed_gaussian.html b/functions/squashed_gaussian.html index af1f4f6d..d0f3063b 100644 --- a/functions/squashed_gaussian.html +++ b/functions/squashed_gaussian.html @@ -3,13 +3,13 @@ - + sleplet.functions.squashed_gaussian API documentation - + @@ -122,7 +122,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/functions/wmap.html b/functions/wmap.html index a8563720..a36f7e9f 100644 --- a/functions/wmap.html +++ b/functions/wmap.html @@ -3,13 +3,13 @@ - + sleplet.functions.wmap API documentation - + @@ -109,7 +109,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/harmonic_methods.html b/harmonic_methods.html index c6602c6a..73fa2e7a 100644 --- a/harmonic_methods.html +++ b/harmonic_methods.html @@ -3,13 +3,13 @@ - + sleplet.harmonic_methods API documentation - + @@ -55,7 +55,7 @@

Returns

The coefficients of a random signal on the sphere.

-def invert_flm_boosted(flm: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]], L: int, resolution: int, *, reality: bool = False, spin: int = 0) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] +def invert_flm_boosted(flm: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]],
L: int,
resolution: int,
*,
reality: bool = False,
spin: int = 0) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

Upsamples the signal and performs the inverse harmonic transform .

@@ -76,7 +76,7 @@

Returns

The boosted field value.

-def mesh_forward(mesh: Mesh, u: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]] +def mesh_forward(mesh: Mesh,
u: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

Compute the mesh forward transform from pixel space to Fourier space.

@@ -91,7 +91,7 @@

Returns

The basis functions of the mesh in Fourier space.

-def mesh_inverse(mesh: Mesh, u_i: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] +def mesh_inverse(mesh: Mesh,
u_i: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

Compute the mesh inverse transform from Fourier space to pixel space.

@@ -106,7 +106,7 @@

Returns

The values on the mesh in pixel space.

-def rotate_earth_to_africa(earth_flm: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], L: int) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]] +def rotate_earth_to_africa(earth_flm: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
L: int) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]

Rotates the harmonic coefficients of the Earth to a view centred on Africa.

@@ -121,7 +121,7 @@

Returns

The spherical harmonic coefficients of the Earth centred on Africa.

-def rotate_earth_to_south_america(earth_flm: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], L: int) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]] +def rotate_earth_to_south_america(earth_flm: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
L: int) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]

Rotates the harmonic coefficients of the Earth to a view centred on South America.

@@ -164,7 +164,7 @@

Returns

diff --git a/index.html b/index.html index 7487f788..3ef8e010 100644 --- a/index.html +++ b/index.html @@ -3,13 +3,13 @@ - + sleplet API documentation - + @@ -1228,7 +1228,7 @@

Sub-modules

diff --git a/meshes/index.html b/meshes/index.html index 87f44067..f080f164 100644 --- a/meshes/index.html +++ b/meshes/index.html @@ -3,13 +3,13 @@ - + sleplet.meshes API documentation - + @@ -650,7 +650,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/meshes/mesh.html b/meshes/mesh.html index 06a03867..bfccf784 100644 --- a/meshes/mesh.html +++ b/meshes/mesh.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh API documentation - + @@ -117,7 +117,7 @@

M diff --git a/meshes/mesh_basis_functions.html b/meshes/mesh_basis_functions.html index a4717be9..5976661a 100644 --- a/meshes/mesh_basis_functions.html +++ b/meshes/mesh_basis_functions.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh_basis_functions API documentation - + @@ -111,7 +111,7 @@

diff --git a/meshes/mesh_coefficients.html b/meshes/mesh_coefficients.html index 1e5657f8..6024d414 100644 --- a/meshes/mesh_coefficients.html +++ b/meshes/mesh_coefficients.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh_coefficients API documentation - + @@ -125,7 +125,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/meshes/mesh_field.html b/meshes/mesh_field.html index 35d13a52..5ca78a8b 100644 --- a/meshes/mesh_field.html +++ b/meshes/mesh_field.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh_field API documentation - + @@ -105,7 +105,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/meshes/mesh_harmonic_coefficients.html b/meshes/mesh_harmonic_coefficients.html index fd791cde..90eba3dc 100644 --- a/meshes/mesh_harmonic_coefficients.html +++ b/meshes/mesh_harmonic_coefficients.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh_harmonic_coefficients API documentation - + @@ -110,7 +110,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/meshes/mesh_noise_field.html b/meshes/mesh_noise_field.html index 9d436697..d45c62a5 100644 --- a/meshes/mesh_noise_field.html +++ b/meshes/mesh_noise_field.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh_noise_field API documentation - + @@ -111,7 +111,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/meshes/mesh_slepian.html b/meshes/mesh_slepian.html index aed3a793..db4db4e6 100644 --- a/meshes/mesh_slepian.html +++ b/meshes/mesh_slepian.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh_slepian API documentation - + @@ -94,7 +94,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/meshes/mesh_slepian_coefficients.html b/meshes/mesh_slepian_coefficients.html index bce0c019..3ce14d19 100644 --- a/meshes/mesh_slepian_coefficients.html +++ b/meshes/mesh_slepian_coefficients.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh_slepian_coefficients API documentation - + @@ -117,7 +117,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/meshes/mesh_slepian_field.html b/meshes/mesh_slepian_field.html index 67d8edf1..e262a595 100644 --- a/meshes/mesh_slepian_field.html +++ b/meshes/mesh_slepian_field.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh_slepian_field API documentation - + @@ -106,7 +106,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/meshes/mesh_slepian_functions.html b/meshes/mesh_slepian_functions.html index fd99abf5..3c64214c 100644 --- a/meshes/mesh_slepian_functions.html +++ b/meshes/mesh_slepian_functions.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh_slepian_functions API documentation - + @@ -111,7 +111,7 @@

diff --git a/meshes/mesh_slepian_noise_field.html b/meshes/mesh_slepian_noise_field.html index 2948cb3e..e5c0c2ab 100644 --- a/meshes/mesh_slepian_noise_field.html +++ b/meshes/mesh_slepian_noise_field.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh_slepian_noise_field API documentation - + @@ -112,7 +112,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/meshes/mesh_slepian_wavelet_coefficients.html b/meshes/mesh_slepian_wavelet_coefficients.html index 0c555371..6b819694 100644 --- a/meshes/mesh_slepian_wavelet_coefficients.html +++ b/meshes/mesh_slepian_wavelet_coefficients.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh_slepian_wavelet_coefficients API documentation - + @@ -121,7 +121,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/meshes/mesh_slepian_wavelets.html b/meshes/mesh_slepian_wavelets.html index 21189f6a..3ef4a576 100644 --- a/meshes/mesh_slepian_wavelets.html +++ b/meshes/mesh_slepian_wavelets.html @@ -3,13 +3,13 @@ - + sleplet.meshes.mesh_slepian_wavelets API documentation - + @@ -121,7 +121,7 @@

diff --git a/noise.html b/noise.html index 26a0b5e2..ce2b478a 100644 --- a/noise.html +++ b/noise.html @@ -3,13 +3,13 @@ - + sleplet.noise API documentation - + @@ -37,7 +37,7 @@

Module sleplet.noise

Functions

-def compute_sigma_noise(signal: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], snr_in: float, *, denominator: int | None = None) ‑> float +def compute_sigma_noise(signal: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
snr_in: float,
*,
denominator: int | None = None) ‑> float

Compute the standard deviation of the noise.

@@ -54,7 +54,7 @@

Returns

The standard deviation of the noise.

-def compute_slepian_mesh_sigma_j(mesh_slepian: MeshSlepian, signal: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], psi_j: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]], snr_in: float) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]] +def compute_slepian_mesh_sigma_j(mesh_slepian: MeshSlepian,
signal: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
psi_j: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]],
snr_in: float) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

Compute \sigma_{j} for wavelets used in denoising the signal.

@@ -73,7 +73,7 @@

Returns

The standard deviation of the noise.

-def compute_snr(signal: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], noise: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], signal_type: str) ‑> float +def compute_snr(signal: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
noise: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
signal_type: str) ‑> float

Compute the signal to noise ratio.

@@ -90,7 +90,7 @@

Returns

The signal-to-noise value of the noised signal.

-def harmonic_hard_thresholding(L: int, wav_coeffs: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]], sigma_j: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]], n_sigma: int) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]] +def harmonic_hard_thresholding(L: int,
wav_coeffs: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]],
sigma_j: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]],
n_sigma: int) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]

Perform thresholding in harmonic space.

@@ -109,7 +109,7 @@

Returns

The thresholded wavelet coefficients.

-def slepian_function_hard_thresholding(L: int, coefficients: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], sigma: float, n_sigma: int, slepian: SlepianFunctions) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]] +def slepian_function_hard_thresholding(L: int,
coefficients: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
sigma: float,
n_sigma: int,
slepian: SlepianFunctions) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]

Perform thresholding in Slepian space.

@@ -130,7 +130,7 @@

Returns

The thresholded Slepian coefficients.

-def slepian_mesh_hard_thresholding(mesh_slepian: MeshSlepian, wav_coeffs: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], sigma_j: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]], n_sigma: int) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] +def slepian_mesh_hard_thresholding(mesh_slepian: MeshSlepian,
wav_coeffs: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
sigma_j: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]],
n_sigma: int) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

Perform thresholding in Slepian space of the mesh.

@@ -149,7 +149,7 @@

Returns

The thresholded wavelet coefficients of the mesh.

-def slepian_wavelet_hard_thresholding(L: int, wav_coeffs: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], sigma_j: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]], n_sigma: int, slepian: SlepianFunctions) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] +def slepian_wavelet_hard_thresholding(L: int,
wav_coeffs: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
sigma_j: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]],
n_sigma: int,
slepian: SlepianFunctions) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

Perform thresholding in Slepian wavelet space.

@@ -199,7 +199,7 @@

Returns

diff --git a/plot_methods.html b/plot_methods.html index 06272be8..0e0ae651 100644 --- a/plot_methods.html +++ b/plot_methods.html @@ -3,13 +3,13 @@ - + sleplet.plot_methods API documentation - + @@ -76,7 +76,7 @@

Returns

The noise adjusted maximum amplitude value.

-def find_max_amplitude(function: Coefficients, *, plot_type: str = 'real', upsample: bool = True) ‑> float +def find_max_amplitude(function: Coefficients,
*,
plot_type: str = 'real',
upsample: bool = True) ‑> float

For a given set of coefficients it finds the largest absolute value for a @@ -120,7 +120,7 @@

Returns

diff --git a/plotting/index.html b/plotting/index.html index 142cee6f..ca0f7060 100644 --- a/plotting/index.html +++ b/plotting/index.html @@ -3,13 +3,13 @@ - + sleplet.plotting API documentation - + @@ -74,7 +74,7 @@

Class variables

Methods

-def execute(self: Self, colour: matplotlib.colors.LinearSegmentedColormap = <matplotlib.colors.LinearSegmentedColormap object>) ‑> None +def execute(self: Self,
colour: matplotlib.colors.LinearSegmentedColormap = <matplotlib.colors.LinearSegmentedColormap object>) ‑> None

Perform the plot.

@@ -199,7 +199,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/slepian/index.html b/slepian/index.html index 346d77da..7f61eb1f 100644 --- a/slepian/index.html +++ b/slepian/index.html @@ -3,13 +3,13 @@ - + sleplet.slepian API documentation - + @@ -268,7 +268,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/slepian/region.html b/slepian/region.html index c2db4b1f..3f69fd42 100644 --- a/slepian/region.html +++ b/slepian/region.html @@ -3,13 +3,13 @@ - + sleplet.slepian.region API documentation - + @@ -112,7 +112,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/slepian/slepian_arbitrary.html b/slepian/slepian_arbitrary.html index 796a765c..d9a7309d 100644 --- a/slepian/slepian_arbitrary.html +++ b/slepian/slepian_arbitrary.html @@ -3,13 +3,13 @@ - + sleplet.slepian.slepian_arbitrary API documentation - + @@ -91,7 +91,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/slepian/slepian_functions.html b/slepian/slepian_functions.html index 15a1e9f6..519da198 100644 --- a/slepian/slepian_functions.html +++ b/slepian/slepian_functions.html @@ -3,13 +3,13 @@ - + sleplet.slepian.slepian_functions API documentation - + @@ -120,7 +120,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/slepian/slepian_limit_lat_lon.html b/slepian/slepian_limit_lat_lon.html index 3ba7b4be..2f1586bd 100644 --- a/slepian/slepian_limit_lat_lon.html +++ b/slepian/slepian_limit_lat_lon.html @@ -3,13 +3,13 @@ - + sleplet.slepian.slepian_limit_lat_lon API documentation - + @@ -106,7 +106,7 @@

diff --git a/slepian/slepian_polar_cap.html b/slepian/slepian_polar_cap.html index 9a4dd702..0c00e3a3 100644 --- a/slepian/slepian_polar_cap.html +++ b/slepian/slepian_polar_cap.html @@ -3,13 +3,13 @@ - + sleplet.slepian.slepian_polar_cap API documentation - + @@ -104,7 +104,7 @@

-

Generated by pdoc 0.11.1.

+

Generated by pdoc 0.11.3.

diff --git a/slepian_methods.html b/slepian_methods.html index 3eaf6a0d..340ce540 100644 --- a/slepian_methods.html +++ b/slepian_methods.html @@ -3,13 +3,13 @@ - + sleplet.slepian_methods API documentation - + @@ -37,7 +37,7 @@

Module sleplet.slepian_methods

Functions

-def choose_slepian_method(L: int, region: Region) ‑> SlepianFunctions +def choose_slepian_method(L: int,
region: Region) ‑> SlepianFunctions

Initialise Slepian object depending on input.

@@ -57,7 +57,7 @@

Returns

The given Slepian object.

-def compute_s_p_omega(L: int, slepian: SlepianFunctions) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]] +def compute_s_p_omega(L: int,
slepian: SlepianFunctions) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]

Compute S_{p}(\omega) for a given region.

@@ -72,7 +72,7 @@

Returns

The complex S_{p}(\omega) values.

-def slepian_forward(L: int, slepian: SlepianFunctions, *, f: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]] | None = None, flm: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] | None = None, mask: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]] | None = None, n_coeffs: int | None = None) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]] +def slepian_forward(L: int,
slepian: SlepianFunctions,
*,
f: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]] | None = None,
flm: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] | None = None,
mask: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]] | None = None,
n_coeffs: int | None = None) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]

Compute the Slepian forward transform for all coefficients.

@@ -95,7 +95,7 @@

Returns

The Slepian coefficients of the inputs.

-def slepian_inverse(f_p: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], L: int, slepian: SlepianFunctions) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]] +def slepian_inverse(f_p: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
L: int,
slepian: SlepianFunctions) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]

Compute the Slepian inverse transform up to the Shannon number.

@@ -112,7 +112,7 @@

Returns

The values on the sphere in pixel space.

-def slepian_mesh_forward(mesh_slepian: MeshSlepian, *, u: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] | None = None, u_i: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] | None = None, mask: bool = False, n_coeffs: int | None = None) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]] +def slepian_mesh_forward(mesh_slepian: MeshSlepian,
*,
u: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] | None = None,
u_i: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] | None = None,
mask: bool = False,
n_coeffs: int | None = None) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

Compute the Slepian forward transform for all coefficients on the mesh.

@@ -133,7 +133,7 @@

Returns

The Slepian coefficients on the mesh.

-def slepian_mesh_inverse(mesh_slepian: MeshSlepian, f_p: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] +def slepian_mesh_inverse(mesh_slepian: MeshSlepian,
f_p: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

Compute the Slepian inverse transform on the mesh up to the Shannon number.

@@ -176,7 +176,7 @@

Returns

diff --git a/wavelet_methods.html b/wavelet_methods.html index b29eb278..e2e9ea22 100644 --- a/wavelet_methods.html +++ b/wavelet_methods.html @@ -3,13 +3,13 @@ - + sleplet.wavelet_methods API documentation - + @@ -37,7 +37,7 @@

Module sleplet.wavelet_methods

Functions

-def axisymmetric_wavelet_forward(L: int, flm: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], wavelets: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]] +def axisymmetric_wavelet_forward(L: int,
flm: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
wavelets: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]

Compute the coefficients of the axisymmetric wavelets.

@@ -54,7 +54,7 @@

Returns

Axisymmetric wavelets coefficients.

-def axisymmetric_wavelet_inverse(L: int, wav_coeffs: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]], wavelets: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]] +def axisymmetric_wavelet_inverse(L: int,
wav_coeffs: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]],
wavelets: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]

Compute the inverse axisymmetric wavelet transform.

@@ -88,7 +88,7 @@

Returns

The Slepian wavelet generating functions.

-def find_non_zero_wavelet_coefficients(wav_coeffs: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], *, axis: int | tuple[int, ...]) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] +def find_non_zero_wavelet_coefficients(wav_coeffs: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
*,
axis: int | tuple[int, ...]) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

Find the coefficients within the shannon number to speed up computations.

@@ -103,7 +103,7 @@

Returns

The non-zero wavelet coefficients.

-def slepian_wavelet_forward(f_p: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], wavelets: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]], shannon: int) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] +def slepian_wavelet_forward(f_p: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
wavelets: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]],
shannon: int) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

Compute the coefficients of the given tiling function in Slepian space.

@@ -120,7 +120,7 @@

Returns

The Slepian wavelets coefficients of the signal.

-def slepian_wavelet_inverse(wav_coeffs: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], wavelets: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]], shannon: int) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]] +def slepian_wavelet_inverse(wav_coeffs: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]],
wavelets: numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]],
shannon: int) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

Compute the inverse wavelet transform in Slepian space.

@@ -165,7 +165,7 @@

Returns