PreparedSurfaceSampler

class hydromodpy.spatial.PreparedSurfaceSampler(values, support, xmin, xmax, ymin, ymax, dx, dy, nrows, ncols)

Bases: object

One ready-to-use raster sampler built from a surface-like object.

Parameters:

• values (ndarray)

• support (object | None)

• xmin (float | None)

• xmax (float | None)

• ymin (float | None)

• ymax (float | None)

• dx (float | None)

• dy (float | None)

• nrows (int | None)

• ncols (int | None)

classmethod from_surface(surface)

Build one sampler from a HydroModPy Surface-like object.

Parameters:

surface (object)

Return type:

PreparedSurfaceSampler

property has_complete_support: bool

Return whether bilinear sampling can be evaluated on this sampler.

sample(x_values, y_values)

Sample the prepared surface at one scalar or array of XY coordinates.

Parameters:

• x_values (Any)

• y_values (Any)

Return type:

ndarray

sample_points_xy(points_xy)

Sample an (n_points, 2) coordinate array.

Parameters:

points_xy (Any)

Return type:

ndarray