py3dinterpolations.core.grid3d.RegularGrid3D

class py3dinterpolations.core.grid3d.RegularGrid3D(x_min: float, x_max: float, y_min: float, y_max: float, z_min: float, z_max: float, gridres: float)

Bases: Grid3D

class for regular 3D grids

Class for a 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

• y_min (float) – minimum value in Y

• y_max (float) – maximum value in Y

• z_min (float) – minimum value in Z

• z_max (float) – maximum value in Z

• gridres (float) – grid resolution, equal in X, Y, Z

Methods

__init__(x_min, x_max, y_min, y_max, z_min, ...)	initialize regular 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