GXHGD class¶

class GXHGD(handle=0)[source]¶

GXHGD class.

High Performance Grid. Designed to place grid data on a DAP server. It produces a multi-resolution compressed object that supports multi-threading and allows for high-speed extraction of data at any resolution.

__init__(handle=0)[source]¶: Initialize self. See help(type(self)) for accurate signature.

classmethod create(name)[source]¶

Create a handle to an GXHGD object

Parameters: name (str) – File Name
Returns: GXHGD handle, terminates if creation fails
Return type: GXHGD

New in version 5.1.

License: Geosoft Open License

export_img(name)[source]¶

Export all layers of this GXHGD into grid files.

Parameters: name (str) – Name of grids (each layers adds _Number to the name)

New in version 6.1.

License: Geosoft Open License

get_meta(meta)[source]¶

Get the metadata of a grid.

Parameters: meta (GXMETA) – GXMETA object to save GXHGD’s meta to

New in version 5.1.

License: Geosoft Open License

classmethod h_create_img(img, name)[source]¶

Make an GXHGD from an GXIMG

Parameters

img (GXIMG) – Image Handle
name (str) – Name of GXHGD object

Returns

GXHGD Object

Return type

GXHGD

New in version 5.1.

License: Geosoft Open License

is_null()[source]¶

Check if this is a null (undefined) instance

Returns: True if this is a null (undefined) instance, False otherwise.
Return type: bool

classmethod null()[source]¶

A null (undefined) instance of GXHGD

Returns: A null GXHGD
Return type: GXHGD

set_meta(meta)[source]¶

Set the metadata of a grid.

Parameters: meta (GXMETA) – GXMETA object to add to GXHGD’s meta

New in version 5.1.

License: Geosoft Open License