Project

Root object of an OMF file.

This is the root element of an OMF file, holding global metadata and a list of Elements that describe the objects or shapes within the file.

Fields

application: string

Optional name and version of the application that created the file, default empty.

author: string

Optional name or email address of the person that created the file, default empty.

coordinate_reference_system: string

Optional EPSG or PROJ local transformation string, default empty.

Exactly what is supported depends on the application reading the file.

date: string

Optional file or data creation date, default empty.

description: string

Optional project description.

elements: array of Element

List of elements.

metadata: object

Arbitrary metadata.

This is the place to put anything that doesn't fit in the other fields. Application-specific data should use a prefix that identifies the application, like "lf-something" for Leapfrog.

name: string

Project name.

origin: 3D vector

Optional project origin, default [0, 0, 0].

Most geometries also have their own origin field. To get the real location add this origin and the geometry origin to all locations within each element.

units: string

Optional unit for distances and locations within the file.

Typically "meters", "metres", "feet", or empty because the coordinate reference system defines it. If both are empty then applications may assume meters.

Schema

{
  "$id": "https://github.com/gmggroup/omf-rust/blob/main/omf.schema.json",
  "title": "Open Mining Format 2.0-beta.1",
  "type": "object",
  "required": [
    "date"
  ],
  "properties": {
    "application": {
      "type": "string"
    },
    "author": {
      "type": "string"
    },
    "coordinate_reference_system": {
      "type": "string"
    },
    "date": {
      "type": "string",
      "format": "date-time"
    },
    "description": {
      "type": "string"
    },
    "elements": {
      "default": [],
      "type": "array",
      "items": {
        "$ref": "#/definitions/Element"
      }
    },
    "metadata": {
      "type": "object",
      "additionalProperties": true
    },
    "name": {
      "type": "string"
    },
    "origin": {
      "type": "array",
      "items": {
        "type": "number",
        "format": "double"
      },
      "maxItems": 3,
      "minItems": 3
    },
    "units": {
      "type": "string"
    }
  }
}