Module sleplet.meshes

Classes to create and handle mesh (manifold) data.

Sub-modules

sleplet.meshes.mesh

Contains the Mesh class.

sleplet.meshes.mesh_basis_functions

Contains the MeshBasisFunctions class.

sleplet.meshes.mesh_coefficients

Contains the abstract MeshCoefficients class.

sleplet.meshes.mesh_field

Contains the MeshField class.

sleplet.meshes.mesh_harmonic_coefficients

Contains the abstract MeshHarmonicCoefficients class.

sleplet.meshes.mesh_noise_field

Contains the MeshNoiseField class.

sleplet.meshes.mesh_slepian

Contains the MeshSlepian class.

sleplet.meshes.mesh_slepian_coefficients

Contains the abstract MeshSlepianCoefficients class.

sleplet.meshes.mesh_slepian_field

Contains the MeshSlepianField class.

sleplet.meshes.mesh_slepian_functions

Contains the MeshSlepianFunctions class.

sleplet.meshes.mesh_slepian_noise_field

Contains the MeshSlepianNoiseField class.

sleplet.meshes.mesh_slepian_wavelet_coefficients

Contains the MeshSlepianWaveletCoefficients class.

sleplet.meshes.mesh_slepian_wavelets

Contains the MeshSlepianWavelets class.

Classes

class Mesh (*args: Any, **kwargs: Any)

Create a mesh object.

Class variables

var basis_functions : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

var faces : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

var mesh_eigenvalues : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

var mesh_region : numpy.ndarray[typing.Any, numpy.dtype[numpy.bool_]]

var name : str

The name of the mesh. Current options bird, cheetah, cube, dragon homer and teapot.

var number_basis_functions : int | None

The number of basis functions to compute from the Laplacian of the given mesh. Defaults to one quarter of the number of vertices o the given mesh.

var vertices : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

var zoom : bool

Whether to zoom in on the pre-selected region of the mesh in the plots.

class MeshBasisFunctions (*args: Any, **kwargs: Any)

Create the eigenfunctions of the Laplacian of the mesh.

Ancestors

• MeshHarmonicCoefficients
• MeshCoefficients

Class variables

var coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var rank : int

Slepian eigenvalues are ordered in decreasing value. The option rank selects a given Slepian function from the spectrum (p in the papers).

var wavelet_coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelets : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

Inherited members

• MeshHarmonicCoefficients:
  • extra_args
  • mesh
  • noise
  • region

class MeshField (*args: Any, **kwargs: Any)

Create a per-vertex normals field on a given mesh.

Ancestors

• MeshHarmonicCoefficients
• MeshCoefficients

Class variables

var coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelet_coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelets : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

Inherited members

• MeshHarmonicCoefficients:
  • extra_args
  • mesh
  • noise
  • region

class MeshNoiseField (*args: Any, **kwargs: Any)

Create a noised per-vertex normals field on a given mesh.

Ancestors

• MeshHarmonicCoefficients
• MeshCoefficients

Class variables

var SNR : float

A parameter which controls the level of signal-to-noise in the noised data.

var coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelet_coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelets : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

Inherited members

• MeshHarmonicCoefficients:
  • extra_args
  • mesh
  • noise
  • region

class MeshSlepian (*args: Any, **kwargs: Any)

Create Slepian object of a given mesh.

Class variables

var N : int

var mesh : Mesh

A mesh object.

var slepian_eigenvalues : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

var slepian_functions : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

class MeshSlepianField (*args: Any, **kwargs: Any)

Create a field on a given mesh computed from a Slepian region of the mesh. The default field is the per-vertex normals of the mesh.

Ancestors

• MeshSlepianCoefficients
• MeshCoefficients

Class variables

var coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelet_coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelets : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

Inherited members

• MeshSlepianCoefficients:
  • extra_args
  • mesh
  • noise
  • region

class MeshSlepianFunctions (*args: Any, **kwargs: Any)

Create Slepian functions of a given mesh.

Ancestors

• MeshSlepianCoefficients
• MeshCoefficients

Class variables

var coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var rank : int

Slepian eigenvalues are ordered in decreasing value. The option rank selects a given Slepian function from the spectrum (p in the papers).

var wavelet_coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelets : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

Inherited members

• MeshSlepianCoefficients:
  • extra_args
  • mesh
  • noise
  • region

class MeshSlepianNoiseField (*args: Any, **kwargs: Any)

Create a noisedfield on a given mesh computed from a Slepian region of the mesh. The default field is the per-vertex normals of the mesh.

Ancestors

• MeshSlepianCoefficients
• MeshCoefficients

Class variables

var SNR : float

A parameter which controls the level of signal-to-noise in the noised data.

var coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelet_coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelets : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

Inherited members

• MeshSlepianCoefficients:
  • extra_args
  • mesh
  • noise
  • region

class MeshSlepianWaveletCoefficients (*args: Any, **kwargs: Any)

Create Slepian wavelet coefficients of a given mesh.

Ancestors

• MeshSlepianCoefficients
• MeshCoefficients

Class variables

var B : int

The wavelet parameter. Represented as $\lambda$ in the papers.

var coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var j : int | None

Option to select a given wavelet. None indicates the scaling function, whereas 0 would correspond to the selected j_min.

var j_min : int

The minimum wavelet scale. Represented as $J_{0}$ in the papers.

var wavelet_coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelets : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

Inherited members

• MeshSlepianCoefficients:
  • extra_args
  • mesh
  • noise
  • region

class MeshSlepianWavelets (*args: Any, **kwargs: Any)

Create Slepian wavelets of a given mesh.

Ancestors

• MeshSlepianCoefficients
• MeshCoefficients

Class variables

var B : int

The wavelet parameter. Represented as $\lambda$ in the papers.

var coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var j : int | None

Option to select a given wavelet. None indicates the scaling function, whereas 0 would correspond to the selected j_min.

var j_min : int

The minimum wavelet scale. Represented as $J_{0}$ in the papers.

var wavelet_coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelets : numpy.ndarray[typing.Any, numpy.dtype[numpy.float64]]

Inherited members

• MeshSlepianCoefficients:
  • extra_args
  • mesh
  • noise
  • region