# maptekomf.vulcan
Provides support for inter-operability with the OMF format and Maptek Vulcan.
The sister package maptekomf.maptek provides support for inter-operability with
the Open Mining Format (OMF) and Maptek applications built on a shared
underlying infrastructure (which Maptek Vulcan is not built on).
## Supported application versions
* Maptek Vulcan 2021.4 and later
Older versions such as Maptek Vulcan 2020 and 2021.x may work but they have
not been tested.
## Implementation defined behaviour
This OMF importer/exporter implementation has the following behaviour that
may be different to how other implementations, scripts and applications handle
a given OMF project file. This is done in places where the OMF specification
does not specify how such cases should be handled, especially in cases
where data can't be represented natively in the data format.
### Naming
The names of objects in an OMF project are not required to be unique.
The names of objects in a given folder in a Vulcan project need be
unique as they are often stored on the file system.
As a result during import if a duplicate name is detected a numerical suffix
will be added.
### Point colouring
Maptek Vulcan's point and line sets have the concept of a per-point colour.
If the colours are not all the same when exporting, then they will be written
as an attribute of type `omf.ColorData` on the object called "point colours".
When importing, the "point colours" attribute will be recognised and read in
as a colour array. Vulcan does not support an arbitrary number of colour
array attributes, it only allows one set of colours for the points.
### Cell visibility
Vulcan's grids have the concept of visibility (or a grid mask), as a way to
hide cells that are not relevant. For example, they may fall outside the data
range (i.e. the area that was measured/recorded). This is achieved by saving it
as an attribute for vertices called "visibility" in OMF and recognising the
attribute in the importer.
## Limitations
* Per-facet attributes are not supported in Vulcan's data types.
* Per-vertex attributes are not supported in Vulcan's data types.
* Grids in Vulcan do not support texturing. This means textures for gridded
surfaces in an OMF file won't be imported.
## Future work
* Import and export for block models.
Support may be added on request; however the plan is to wait until this
package is updated to use omf-2.0.
* Upgrade omf package from 1.0 to 2.0.
* Support importing/exporting textured surfaces.
* Support SCD (Colour map/legend) files and colour maps in general.
## Distribution
This project is typically distributed as a Python wheel through PyPi.
However, other mechanisms exist.
Raw data
{
"_id": null,
"home_page": null,
"name": "maptekomf-vulcan",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.7",
"maintainer_email": null,
"keywords": "mining, data, interchange",
"author": null,
"author_email": "Maptek <support@maptek.com.au>",
"download_url": null,
"platform": null,
"description": "# maptekomf.vulcan\r\nProvides support for inter-operability with the OMF format and Maptek Vulcan.\r\n\r\nThe sister package maptekomf.maptek provides support for inter-operability with\r\nthe Open Mining Format (OMF) and Maptek applications built on a shared\r\nunderlying infrastructure (which Maptek Vulcan is not built on).\r\n\r\n## Supported application versions\r\n* Maptek Vulcan 2021.4 and later\r\n\r\nOlder versions such as Maptek Vulcan 2020 and 2021.x may work but they have\r\nnot been tested.\r\n\r\n## Implementation defined behaviour\r\nThis OMF importer/exporter implementation has the following behaviour that\r\nmay be different to how other implementations, scripts and applications handle\r\na given OMF project file. This is done in places where the OMF specification\r\ndoes not specify how such cases should be handled, especially in cases\r\nwhere data can't be represented natively in the data format.\r\n\r\n### Naming\r\nThe names of objects in an OMF project are not required to be unique.\r\nThe names of objects in a given folder in a Vulcan project need be\r\nunique as they are often stored on the file system.\r\n\r\nAs a result during import if a duplicate name is detected a numerical suffix\r\nwill be added.\r\n\r\n### Point colouring\r\nMaptek Vulcan's point and line sets have the concept of a per-point colour.\r\n\r\nIf the colours are not all the same when exporting, then they will be written\r\nas an attribute of type `omf.ColorData` on the object called \"point colours\".\r\n\r\nWhen importing, the \"point colours\" attribute will be recognised and read in\r\nas a colour array. Vulcan does not support an arbitrary number of colour\r\narray attributes, it only allows one set of colours for the points.\r\n\r\n### Cell visibility\r\nVulcan's grids have the concept of visibility (or a grid mask), as a way to\r\nhide cells that are not relevant. For example, they may fall outside the data\r\nrange (i.e. the area that was measured/recorded). This is achieved by saving it\r\nas an attribute for vertices called \"visibility\" in OMF and recognising the\r\nattribute in the importer.\r\n\r\n## Limitations\r\n\r\n* Per-facet attributes are not supported in Vulcan's data types.\r\n* Per-vertex attributes are not supported in Vulcan's data types.\r\n* Grids in Vulcan do not support texturing. This means textures for gridded\r\n surfaces in an OMF file won't be imported.\r\n\r\n## Future work\r\n* Import and export for block models.\r\n Support may be added on request; however the plan is to wait until this\r\n package is updated to use omf-2.0.\r\n* Upgrade omf package from 1.0 to 2.0.\r\n* Support importing/exporting textured surfaces.\r\n* Support SCD (Colour map/legend) files and colour maps in general.\r\n\r\n## Distribution\r\nThis project is typically distributed as a Python wheel through PyPi.\r\nHowever, other mechanisms exist.\r\n",
"bugtrack_url": null,
"license": "Maptek End User Licence Agreement",
"summary": "Provides interoperability between Vulcan and OMF.",
"version": "1.0.2",
"project_urls": {
"Documentation": "https://help.maptek.com/mapteksdk/",
"Homepage": "https://www.maptek.com",
"Support": "https://www.maptek.com/support/index.html"
},
"split_keywords": [
"mining",
" data",
" interchange"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8beb1981735dc1570502f6edfe6272e3fbe823f655681a98c34edb3e6e971f02",
"md5": "dee144093a27b91b51e097cab7af21c6",
"sha256": "e5bbad769160fb87220e056e102bf5388920ba1f24394871be7295d822a4ce96"
},
"downloads": -1,
"filename": "maptekomf_vulcan-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dee144093a27b91b51e097cab7af21c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.7",
"size": 22339,
"upload_time": "2024-06-18T05:38:07",
"upload_time_iso_8601": "2024-06-18T05:38:07.882843Z",
"url": "https://files.pythonhosted.org/packages/8b/eb/1981735dc1570502f6edfe6272e3fbe823f655681a98c34edb3e6e971f02/maptekomf_vulcan-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-18 05:38:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "maptekomf-vulcan"
}
JSON