regular-masked-3d-grid
The regular-masked-3d-grid object captures the geometry and attributes of a regular grid with inactive cells. This object is used to represent a 3D grid where only active cells are considered for attribute properties. As a result, the size of the attribute data can be much smaller than the underlying regular grid.
This object is particularly useful in geological and geostatistical analysis when working with a sub-space of a regular grid, such as a domain or a mining pit. It eliminates the need to externally track which cells are inside or outside the region of interest.
To define the regular masked 3D grid, the object requires:
- The dimensions of the grid in number of cells.
- The coordinates of the origin [x, y, z].
- The size of each cell in the grid [cell_size_x, cell_size_y, cell_size_z].
- A mask (boolean array) indicating active and inactive cells.
- The number of active cells, which corresponds to the number of true elements in the mask.
- The orientation of the grid (defined per the Rotation schema component).
The grid origin is defined in three dimensions, along with rotation. The origin is set at the corner of the grid.
The size of the cells in the grid corresponds to the number of true elements in the boolean mask array. Each cell has the same length, width, and height, as defined by the cell size, throughout the grid.
The cell_attributes field accepts a variety of scalar values (see One of Attribute component), defined for number_of_active_cells (number of true elements in the mask array).
As with all objects, this grid implements spatial properties including a coordinate reference system and bounding box in world coordinates.
See also:
- For a 3D grid with data defined on all cells or vertices, see
regular-3d-grid. - For a 3D grid with tensor values, see
tensor-3d-grid.
Properties
regular-masked-3d-grid (v1.3.0)
A 3D regular masked grid (all cells are equal size). The mask attribute will indicate which cells have values.
| Property | Type | Description | Flags |
|---|---|---|---|
| name | String | Name of the object. | ⬆️ ✅ |
| uuid | base-object-properties | Identifier of the object. | ⬆️ ✅ |
| description | String | Optional field for adding additional description to uniquely identify this object. | ⬆️ |
| extensions | Object | Extended properties that may be associated to the object, but not specified in the schema | ⬆️ |
| tags | Object | Key-value pairs of user-defined metadata | ⬆️ |
| lineage | lineage | Information about the history of the object | ⬆️ |
| bounding_box | bounding-box | Bounding box of the spatial data. | ⬆️ ✅ |
| coordinate_reference_system | crs | Coordinate system of the spatial data | ⬆️ ✅ |
| schema | String | ✅ | |
| origin | Array[Number] | The coordinates of the origin [x,y,z] | ✅ |
| size | Array[Integer] | Number of cells in each direction. [grid_size_x, grid_size_y, grid_size_z] | ✅ |
| cell_size | Array[Number] | The size of each cell in the grid. [cell_size_x, cell_size_y, cell_size_z] | ✅ |
| rotation | rotation | Orientation of the grid. | |
| mask | bool-attribute | Attribute that indicates which cells have values. | ✅ |
| number_of_active_cells | Integer | Number of active cells. | ✅ |
| cell_attributes | one-of-attribute | Attributes associated with the cells. |
Legend
| Flag | Description |
|---|---|
| ⬆️ | Inherited property |
| ✅ | Required property |
