map2loop.sampler.Sampler

class map2loop.sampler.Sampler

Bases: ABC

Base Class of Sampler used to force structure of Sampler

Parameters:

ABC (ABC) – Derived from Abstract Base Class

Initialiser of for Sampler

__init__()

Initialiser of for Sampler

Methods

__init__()	Initialiser of for Sampler
sample(spatial_data[, map_data])	Execute sampling method (abstract method)
type()	Getter for subclass type label

abstract sample(spatial_data: GeoDataFrame, map_data: MapData | None = None) → DataFrame

Execute sampling method (abstract method)

Parameters:

spatial_data (geopandas.GeoDataFrame) – data frame to sample

Returns:

pandas.DataFrame – data frame containing samples

type()

Getter for subclass type label

Returns:

str – Name of subclass