py3dinterpolations.core.grid3d.Grid3D

class py3dinterpolations.core.grid3d.Grid3D(x_min: float, x_max: float, x_res: float, y_min: float, y_max: float, y_res: float, z_min: float, z_max: float, z_res: float)

Bases: object

base class for 3D grids

This is the base class for 3D grids. It contains the basic attributes and methods.

Implemented child grid types:

• RegularGrid3D : regular 3D grid with equal spacing in X, Y, Z

Parameters

• x_min (float) – minimum value in X

• x_max (float) – maximum value in X

• x_res (float) – resolution in X

• y_min (float) – minimum value in Y

• y_max (float) – maximum value in Y

• y_res (float) – resolution in Y

• z_min (float) – minimum value in Z

• z_max (float) – maximum value in Z

• z_res (float) – resolution in Z

X

X axis

Type

GridAxis

Y

Y axis

Type

GridAxis

Z

Z axis

Type

GridAxis

grid

dictionary with X, Y, Z grid arrays

Type

dict

normalized_grid

dictionary with normalized X, Y, Z grid arrays

Type

dict

mesh

dictionary with X, Y, Z mesh arrays

Type

dict

gridres

grid resolution

Type

dict

results

dictionary with interpolated, variance results

Type

dict

Properties:

gridres (dict): grid resolution n_cells (int): number of cells

Methods

__init__(x_min, x_max, x_res, y_min, y_max, ...)	initialize grid
get_axis(axis)	get grid axis

Attributes

X
Y
Z
grid
gridres
mesh
normalized_grid
results

get_axis(axis: str) → GridAxis

get grid axis

Parameters

axis (str) – axis name, one of X, Y, Z

Returns

grid axis

Return type

GridAxis

Raises

ValueError – invalid axis