Skip to content

scalar_grf

ScalarGRFDataLoader(bounds, params)

Bases: ScalarDataLoader

add_default_params(params)

Set default values for abstract GRF dataloaders, starting by including defaults for scalar dataloaders.

Parameters:

Name Type Description Default
params dict

Dictionary containing attributes that are required for the shape being loaded. Must include 'shape'.

required

Returns:

Type Description
dict

Dictionary of attributes the dataloader will require, completed with default values if not provided in config.

import_data(bounds)

Creates data in the form of a Gaussian Random Field

Parameters:

Name Type Description Default
bounds Boundary

Initial boundary to limit the dataset to

required

Returns:

Type Description

pd.DataFrame: Scalar dataset within limits of bounds. Dataset has coordinates 'lat', 'long', and variable name 'data'.

NOTE - In init, variable name will be set to data_name if defined in config