verde.Chain¶

class verde.Chain(steps)[source]¶

Chain filtering operations to fit on each subsequent output.

The filter method of each element of the set is called with the outputs of the previous one. For gridders and trend estimators this means that each element fits the residuals (input data minus predicted data) of the previous one.

When predicting data, the predictions of each step in the chain are added together. Steps that don’t implement a predict method are ignored.

This provides a convenient way to chaining operations like trend estimation to a given gridder.

Parameters

steps (list) – A list of ('name', step) pairs where step is any verde class that implements a filter(coordinates, data, weights) method (including Chain itself).

Variables

region_ (tuple) – The boundaries ([W, E, S, N]) of the data used to fit the chain. Used as the default region for the grid and scatter methods.
named_steps (dict) – A dictionary version of steps where the 'name' strings are keys and the estimator/gridder/processor objects are the values.

See also

verde.Vector: Fit an estimator to each component of vector data

Methods Summary

`Chain.filter`(coordinates, data[, weights])	Filter the data through the gridder and produce residuals.
`Chain.fit`(coordinates, data[, weights])	Fit the chained estimators to the given data.
`Chain.get_params`([deep])	Get parameters for this estimator.
`Chain.grid`([region, shape, spacing, dims, …])	Interpolate the data onto a regular grid.
`Chain.predict`(coordinates)	Evaluates the data predicted by the chain on the given set of points.
`Chain.profile`(point1, point2, size[, dims, …])	Interpolate data along a profile between two points.
`Chain.scatter`([region, size, random_state, …])	Interpolate values onto a random scatter of points.
`Chain.score`(coordinates, data[, weights])	Score the gridder predictions against the given data.
`Chain.set_params`(**params)	Set the parameters of this estimator.

Chain.filter(coordinates, data, weights=None)¶

Filter the data through the gridder and produce residuals.

Calls fit on the data, evaluates the residuals (data - predicted data), and returns the coordinates, residuals, and weights.

No very useful by itself but this interface makes gridders compatible with other processing operations and is used by verde.Chain to join them together (for example, so you can fit a spline on the residuals of a trend).

Parameters

coordinates (tuple of arrays) – Arrays with the coordinates of each data point. Should be in the following order: (easting, northing, vertical, …).
data (array or tuple of arrays) – The data values of each data point. If the data has more than one component, data must be a tuple of arrays (one for each component).
weights (None or array or tuple of arrays) – If not None, then the weights assigned to each data point. If more than one data component is provided, you must provide a weights array for each data component (if not None).

Returns

coordinates, residuals, weights – The coordinates and weights are same as the input. Residuals are the input data minus the predicted data.

Chain.fit(coordinates, data, weights=None)[source]¶

Fit the chained estimators to the given data.

Each estimator in the chain is fitted to the residuals of the previous estimator. The coordinates are preserved. Only the data values are changed.

The data region is captured and used as default for the grid and scatter methods.

All input arrays must have the same shape.

Parameters

coordinates (tuple of arrays) – Arrays with the coordinates of each data point. Should be in the following order: (easting, northing, vertical, …).
data (array or tuple of arrays) – the data values of each data point. if the data has more than one component, data must be a tuple of arrays (one for each component).
weights (none or array or tuple of arrays) – if not none, then the weights assigned to each data point. if more than one data component is provided, you must provide a weights array for each data component (if not none).

Returns

self – Returns this estimator instance for chaining operations.

Chain.get_params(deep=True)¶

Get parameters for this estimator.

Parameters: deep (bool, default=True) – If True, will return the parameters for this estimator and contained subobjects that are estimators.
Returns: params (mapping of string to any) – Parameter names mapped to their values.

Chain.grid(region=None, shape=None, spacing=None, dims=None, data_names=None, projection=None, **kwargs)¶

Interpolate the data onto a regular grid.

The grid can be specified by either the number of points in each dimension (the shape) or by the grid node spacing. See verde.grid_coordinates for details. Other arguments for verde.grid_coordinates can be passed as extra keyword arguments (kwargs) to this method.

If the interpolator collected the input data region, then it will be used if region=None. Otherwise, you must specify the grid region.

Use the dims and data_names arguments to set custom names for the dimensions and the data field(s) in the output xarray.Dataset. Default names will be provided if none are given.

Parameters

region (list = [W, E, S, N]) – The boundaries of a given region in Cartesian or geographic coordinates.
shape (tuple = (n_north, n_east) or None) – The number of points in the South-North and West-East directions, respectively.
spacing (tuple = (s_north, s_east) or None) – The grid spacing in the South-North and West-East directions, respectively.
dims (list or None) – The names of the northing and easting data dimensions, respectively, in the output grid. Defaults to ['northing', 'easting']. NOTE: This is an exception to the “easting” then “northing” pattern but is required for compatibility with xarray.
data_names (list of None) – The name(s) of the data variables in the output grid. Defaults to ['scalars'] for scalar data, ['east_component', 'north_component'] for 2D vector data, and ['east_component', 'north_component', 'vertical_component'] for 3D vector data.
projection (callable or None) – If not None, then should be a callable object projection(easting, northing) -> (proj_easting, proj_northing) that takes in easting and northing coordinate arrays and returns projected northing and easting coordinate arrays. This function will be used to project the generated grid coordinates before passing them into predict. For example, you can use this to generate a geographic grid from a Cartesian gridder.

Returns