omf_io.reader.reader.OMFReader

class omf_io.reader.reader.OMFReader(filepath)

A class limited to reading an OMF file.

__init__(filepath)

Instantiate the OMFPandas object.

Parameters:

filepath (Path) – Path to the OMF file.

Raises:

• FileNotFoundError – If the OMF file does not exist.

• ValueError – If the file is not an OMF file.

Methods

__init__(filepath)	Instantiate the OMFPandas object.
export_blockmodel_profile_report(**kwargs)
export_blockmodel_to_file(blockmodel_name, ...)	Convert a blockmodel to a file.
export_image_to_file(image_name, output_file)	Convert an image to a file.
export_surface_to_raster_file(surface_name, ...)	Convert a surface to a raster file.

Attributes

element_types

Dictionary of elements keyed by name

export_blockmodel_to_file(blockmodel_name, output_file)

Convert a blockmodel to a file.

Parameters:

• blockmodel_name (str) – The name of the blockmodel to convert.

• output_file (PathLike) – The output file path.

export_image_to_file(image_name, output_file)

Convert an image to a file.

Example use case is converting an ortho-image to a jpg

Parameters:

• image_name (str) – The name of the image to convert.

• output_file (PathLike) – The output file path.

export_surface_to_raster_file(surface_name, output_file)

Convert a surface to a raster file.

Example use case is converting an elevation surface to a GeoTIFF.

Parameters:

• surface_name (str) – The name of the surface to convert.

• output_file (PathLike) – The output raster file path.