Volume

Transferring a block model from Resource Estimation software into Mine planning software.

../_images/VolumeGrid.png

Element

class omf.volume.VolumeElement(**kwargs)[source]

Contains mesh, data, and options of a volume

Required Properties:

  • color (Color): Solid color, a color, Default: random
  • description (String): Description, a unicode string
  • geometry (VolumeGridGeometry): Structure of the volume element, an instance of VolumeGridGeometry
  • name (String): Title, a unicode string
  • subtype (StringChoice): Category of Volume, any of “volume”, Default: volume

Optional Properties:

  • data (a list of ProjectElementData): Data defined on the element, a list (each item is an instance of ProjectElementData)

Other Properties:

  • date_created (GettableProperty): Date project was created
  • date_modified (GettableProperty): Date project was modified
  • uid (Uuid): Unique identifier, a unique ID auto-generated with uuid.uuid4()

Geometry

../_images/VolumeGridGeometry.png
class omf.volume.VolumeGridGeometry(**kwargs)[source]

Contains spatial information of a 3D grid volume.

Required Properties:

  • axis_u (Vector3): Vector orientation of u-direction, a 3D Vector of <type ‘float’> with shape (3), Default: X
  • axis_v (Vector3): Vector orientation of v-direction, a 3D Vector of <type ‘float’> with shape (3), Default: Y
  • axis_w (Vector3): Vector orientation of w-direction, a 3D Vector of <type ‘float’> with shape (3), Default: Z
  • origin (Vector3): Origin of the Mesh relative to origin of the Project, a 3D Vector of <type ‘float’> with shape (3), Default: [0.0, 0.0, 0.0]
  • tensor_u (Array): Tensor cell widths, u-direction, a list or numpy array of <type ‘float’> with shape (*)
  • tensor_v (Array): Tensor cell widths, v-direction, a list or numpy array of <type ‘float’> with shape (*)
  • tensor_w (Array): Tensor cell widths, w-direction, a list or numpy array of <type ‘float’> with shape (*)

Other Properties:

  • date_created (GettableProperty): Date project was created
  • date_modified (GettableProperty): Date project was modified
  • uid (Uuid): Unique identifier, a unique ID auto-generated with uuid.uuid4()

Data

Data is a list of data. For Volumes, location='vertices' and location='cells' are valid.