Module sleplet.slepian

Classes to create the Slepian regions on the sphere.

Sub-modules

sleplet.slepian.region

Contains the Region class.

sleplet.slepian.slepian_arbitrary

Contains the SlepianArbitrary class.

sleplet.slepian.slepian_functions

Contains the abstract SlepianFunctions class.

sleplet.slepian.slepian_limit_lat_lon

Contains the SlepianLimitLatLon class.

sleplet.slepian.slepian_polar_cap

Contains the SlepianPolarCap class.

Classes

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

Identify and create the appropriate Slepian region for the sphere.

Instance variables

var gap : bool

Whether to enable a double ended polar cap, set by the POLAR_GAP environment variable. Only relevant if theta_max is not 180 and the other angles are at their default values.

var mask_name : str

The name of the mask of the arbitrary region, set by the SLEPIAN_MASK environment variable. Current options are africa and south_america.

var phi_max : float

For a limited latitude longitude region, set by the PHI_MAX environment variable.

var phi_min : float

For a limited latitude longitude region, set by the PHI_MIN environment variable.

var theta_max : float

Set by the THETA_MAX environment variable. When set without the other angles it controls a polar cap region. When in conjunction with the others it is for a limited latitude longitude region.

var theta_min : float

For a limited latitude longitude region, set by the THETA_MIN environment variable.

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

Class to create an arbitrary Slepian region on the sphere.

Ancestors

Instance variables

var mask_name : str

The name of the mask of the arbitrary region.

Inherited members

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

Class to create a limited latitude longitude Slepian region on the sphere.

Ancestors

Instance variables

var phi_max : float

Maximum \phi value.

var phi_min : float

Minimum \phi value.

var theta_max : float

Maximum \theta value.

var theta_min : float

Minimum \theta value.

Inherited members

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

Class to create a polar cap Slepian region on the sphere.

Ancestors

Instance variables

var gap : bool

Whether to enable a double ended polar cap.

var order : int | numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[numpy.int64]] | None

By default (i.e. None) all orders (i.e. m) will be computed. If order is specified by an integer then only a given order m will be computed. In the Slepian eigenproblem formulation this simplifies the mathematical formulation.

var theta_max : float

Set the size of the polar cap region.

Inherited members