GXSURFACE class

class geosoft.gxapi.GXSURFACE
The SURFACE class allows you to create, read and alter Geosurface files (*.geosoft_surface).
A Geosurface file can contain one or more surface items (see SURFACEITEM class). In turn each item can
contains one or more triangular polyhedral meshes.
add_surface_item((GXSURFACEITEM)arg1) → None:
Add a new surface item to the SURFACE
Parameters:arg1 (geosoft.gxapi.GXSURFACEITEM) – SURFACEITEM to add
Returns:Nothing
Return type:None

New in version 8.4.0.

static append_vulcan_triangulation((str)arg1, (GXIPJ)arg2, (str)arg3) → None:
Create new surface from a Maptek Vulcan triangulation file and add to an existing geosurface.
Parameters:
Returns:

Nothing
Return type:

None

New in version 8.4.0.

static crc((str)arg1, (str)arg2, (int_ref)arg3) → int:
Compute an XML CRC of a Geosurface file.
Parameters:
  • arg1 (str) – Geosurface file
  • arg2 (str) – output file
  • arg3 (geosoft.gxapi.int_ref) – CRC (unused, always set to 0)
Returns:

CRC Value (always 0)
Return type:

int

New in version 8.0.0.

static create((str)arg1, (GXIPJ)arg2) → GXSURFACE:
Create a new Geosurface file
Parameters:
  • arg1 (str) – Geosurface file name
  • arg2 (geosoft.gxapi.GXIPJ) – IPJ containing coordinate system of the Geosurface
Returns:

SURFACE Object
Return type:

geosoft.gxapi.GXSURFACE

New in version 8.4.0.

static create_from_dxf((GXIPJ)arg1, (str)arg2, (str)arg3) → None:
Create Geosurface file from DXF file.
Parameters:
Returns:

Nothing
Return type:

None

New in version 8.2.0.

static create_from_vulcan_triangulation((str)arg1, (GXIPJ)arg2, (str)arg3) → None:
Create Geosurface file from a Maptek Vulcan triangulation file.
Parameters:
Returns:

Nothing
Return type:

None

New in version 8.4.0.

static get_closed_surface_names((str)arg1, (GXLST)arg2) → None:
Get the names of closed surface items in a Geosurface file (may return an empty list)
Parameters:
  • arg1 (str) – Geosurface file
  • arg2 (geosoft.gxapi.GXLST) – LST to fill (may return an empty LST if none of the surfaces are closed)
Returns:

Nothing
Return type:

None

New in version 8.0.0.

get_extents((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6) → None:
Get the spatial range of all surface items.
Parameters:
Returns:

Nothing
Return type:

None

New in version 8.5.0.

get_ipj((GXIPJ)arg1) → None:
Get the coordinate system of the SURFACE.
Parameters:arg1 (geosoft.gxapi.GXIPJ) – IPJ in which to place the Geosurface coordinate system
Returns:Nothing
Return type:None

New in version 8.4.0.

get_surface_item((str)arg1) → GXSURFACEITEM:
Get the an existing surface item from the SURFACE
Parameters:arg1 (str) – Item GUID
Returns:SURFACEITEM Object
Return type:geosoft.gxapi.GXSURFACEITEM

New in version 8.4.0.

get_surface_items((GXLST)arg1) → None:
Get the surfaces items in a Geosurface file
Parameters:arg1 (geosoft.gxapi.GXLST) – LST to fill
Returns:Nothing
Return type:None

New in version 8.4.0.

static get_surface_names((str)arg1, (GXLST)arg2) → None:
Get the surface item names in a Geosurface file
Parameters:
Returns:

Nothing
Return type:

None

New in version 8.0.0.

is_null() → bool

Check if the instance of geosoft.gxapi.GXSURFACE is null (undefined)

Returns:True if this is a null instance of geosoft.gxapi.GXSURFACE, False otherwise.
Return type:bool`
static null() → GXSURFACE

A null (undefined) instance of geosoft.gxapi.GXSURFACE

Returns:A null geosoft.gxapi.GXSURFACE
Return type:geosoft.gxapi.GXSURFACE
static open((str)arg1, (int)arg2) → GXSURFACE:
Open a Geosurface file
Parameters:
Returns:

SURFACE Object
Return type:

geosoft.gxapi.GXSURFACE

New in version 8.4.0.

set_ipj((GXIPJ)arg1) → None:
Change the coordinate system of the SURFACE.
Parameters:arg1 (geosoft.gxapi.GXIPJ) – IPJ containing the new coordinate system of the Geosurface
Returns:Nothing
Return type:None

New in version 8.4.0.

static sync((str)arg1) → None:
Syncronize the Metadata for this Geosurface
Parameters:arg1 (str) – Geosurface file
Returns:Nothing
Return type:None

New in version 8.0.0.

SURFACE_OPEN constants

Open Modes
gxapi.SURFACE_OPEN_READ = 0
gxapi.SURFACE_OPEN_READWRITE = 1