Voxels🍋
Voxel (GridObject)
🍋
A Voxel is grid of regular cells, i-e: - all cells have the same size and geometry - cells are contiguous
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name |
str |
object name. |
required |
shape |
~IntArray |
number of cells respectively along U, V, W axes. |
required |
origin |
~Vector |
3D point where voxel starts from. |
[0.0, 0.0, 0.0] |
axis |
Union[List[~Vector], numpy.ndarray] |
direction and size along the axis. |
[[1.0, 0.0, 0.0], [0.0, 1.0, 0.0], [0.0, 0.0, 1.0]] |
coords_labels |
List[geolime.base.enums.Coord] |
labels of the coordinates along each provided dimension. |
[<Coord.U: 'U'>, <Coord.V: 'V'>, <Coord.W: 'W'>] |
Exceptions:
| Type | Description |
|---|---|
ValueError |
Object name is not provided |
ValueError |
Number of dimensions is not equal to number of axis |
ValueError |
Dimension along any axis is negative |
ValueError |
Origin or any cell vector doesn't have 3 components X, Y, Z |
Info
Note that the grid may not be cartesian. By default, Voxel is 3D however it does support multiple dimensions (2D, 3D, 4D, etc.).