`perturbation.CorrelatedSphericalGaussian`¶

Import path: earth2studio.perturbation.CorrelatedSphericalGaussian

Documentation¶

Produces Gaussian random field on the sphere with Matern covariance peturbation method output to a lat lon grid.

Warning

Presently this method generates noise on equirectangular grid of size [N, 2N] when N is even or [N+1, 2N] when N is odd.

Parameters:

noise_amplitude (float | Tensor) –

Overall amplitude scaling factor for the noise field. Must be provided.
sigma (float, default: 1.0 ) –

Standard deviation of the noise field, by default 1.0
length_scale (float, default: 500000.0 ) –

Spatial correlation length scale in meters, by default 5.0e5
time_scale (float, default: 48.0 ) –

Temporal correlation scale in hours for the AR(1) process, by default 48.0

Raises:

__call__(
    x: Tensor, coords: CoordSystem
) -> tuple[Tensor, CoordSystem]

Apply perturbation method

Parameters:

x (Tensor) –

Input tensor intended to apply perturbation on
coords (CoordSystem) –

Ordered dict representing coordinate system that describes the tensor, must contain "lat" and "lon" coordinates

Returns:

tuple[torch.Tensor, CoordSystem]: –

Output tensor and respective coordinate system dictionary