Surface

Transfer geological domains from 3D modelling software to Resource Estimation software.

../_images/Surface.png

Elements

../_images/SurfaceGeometry.png
class omf.surface.SurfaceElement(**kwargs)[source]

Contains triangulated surface spatial information and attributes

Required Properties:

  • description (String): Description of the object, a unicode string
  • metadata (ArbitraryMetadataDict): Element metadata, an arbitrary JSON-serializable dictionary, with certain keys validated against ElementMetadata
  • name (String): Title of the object, a unicode string
  • subtype (StringChoice): Category of Surface, any of “surface”, Default: surface
  • triangles (Array): Vertex indices of surface triangles, an instance of Array
  • uid (String): Unique identifier, a unicode string, Default: new instance of unicode
  • vertices (Array): Spatial coordinates of vertices relative to surface origin, an instance of Array

Optional Properties:

  • data (a list of ProjectElementData): Data defined on the element, a list (each item is an instance of ProjectElementData)
  • textures (a list of ProjectedTexture, a list of UVMappedTexture): Images mapped on the element, a list (each item is an instance of ProjectedTexture or an instance of UVMappedTexture)
../_images/SurfaceGridGeometry.png
class omf.surface.SurfaceGridElement(**kwargs)[source]

Contains 2D grid spatial information and attributes

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
  • description (String): Description of the object, a unicode string
  • metadata (ArbitraryMetadataDict): Element metadata, an arbitrary JSON-serializable dictionary, with certain keys validated against ElementMetadata
  • name (String): Title of the object, a unicode string
  • origin (Vector3): Origin of the Mesh relative to Project coordinate reference system, a 3D Vector of <type ‘float’> with shape (3), Default: [0.0, 0.0, 0.0]
  • subtype (StringChoice): Category of Surface, any of “surface”, Default: surface
  • tensor_u (a list of Float): Grid cell widths, u-direction, a list (each item is a float in range [0.0, inf])
  • tensor_v (a list of Float): Grid cell widths, v-direction, a list (each item is a float in range [0.0, inf])
  • uid (String): Unique identifier, a unicode string, Default: new instance of unicode

Optional Properties:

  • data (a list of ProjectElementData): Data defined on the element, a list (each item is an instance of ProjectElementData)
  • offset_w (Array): Node offset, an instance of Array
  • textures (a list of ProjectedTexture, a list of UVMappedTexture): Images mapped on the element, a list (each item is an instance of ProjectedTexture or an instance of UVMappedTexture)

Data

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

Textures

Textures are ImageTexture mapped to the Surface.