map2loop.interpolators.Interpolator

class map2loop.interpolators.Interpolator

Bases: ABC

Base Class of Interpolator used to force structure of Interpolator

Parameters:

ABC (ABC) – Derived from Abstract Base Class

Initialiser of for Interpolator

__init__()

Initialiser of for Interpolator

Methods

__init__()	Initialiser of for Interpolator
interpolate(ni)	Interpolator method
setup_grid(bounding_box)	abstract method to setup an XY grid (abstract method)
setup_interpolation(structure_data)	abstract method to setup interpolation (abstract method)
type()	Getter for subclass type label

abstract interpolate(ni: list | ndarray)

Interpolator method

Parameters:

ni (int) – number of points

Returns:

float – interpolated value

abstract setup_grid(bounding_box: dict)

abstract method to setup an XY grid (abstract method)

Parameters:

• bounding_box (dict) – a dictionary containing the bounding box of the map data.

• format (The bounding box dictionary should comply with the following) –

  { “minx”: value, “maxx”: value, “miny”: value, “maxy”: value,

• }

abstract setup_interpolation(structure_data: DataFrame)

abstract method to setup interpolation (abstract method)

Parameters:

structure_data (pandas.DataFrame) – sampled structural data

type()

Getter for subclass type label

Returns:

str – Name of subclass