Gridded Surface🍋
GriddedSurface (GridObject)
🍋
A GriddedSurface is a XY oriented elevation surface with fixed cell size between its points. The grid points are defined at its corners in the XY plane and the Z-value of the points are not constrained. Gridded surfaces cannot be multi-Z. The cells may not be contiguous and don't have to all be defined.
For instance, a gridded surface can be of shape 5 x 3 x 2 but only have 3 cells defined at [1, 2, 1], [1, 3, 1] and [2, 3, 1].
Grid shape and cell sizes are inferred from the X, Y geometry. The grid is assumed to be cartesian and to have a constant cell size.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str |
object name. |
required |
xyz |
~Data |
cell corners of the gridded surface. |
required |
atol |
float |
absolute tolerance used to automatically calculate the cell dimension. It is the distance tolerance (same unit as xyz) to consider whether the dimensions of all cells can be considered equal. Defaults to 0.001. |
0.001 |
Exceptions:
Type | Description |
---|---|
ValueError |
Variable cell size is inferred. |
ValueError |
There is a single cell in one of the axes. |