GXMESHUTIL class

class GXMESHUTIL(handle=0)

GXMESHUTIL class.

Mesh utility methods.

classmethod clip_surface_with_extents(inputSurfaceFile, inputSurface, outputSurfaceFile, outputSurfaceName, min_x, max_x, min_y, max_y, min_z, max_z)

Clip a Surface with X,Y,Z extents

Parameters:
  • inputSurfaceFile (str) – Input Geosurface file
  • inputSurface (str) – Input Surface name within Geosurface file
  • outputSurfaceFile (str) – Output Surface file
  • outputSurfaceName (str) – Output Surface name
  • min_x (float) – Min value of X
  • max_x (float) – Max value of X
  • min_y (float) – Min value of Y
  • max_y (float) – Max value of Y
  • min_z (float) – Min value of Z
  • max_z (float) – Max value of Z

New in version 9.5.

License: Geosoft Open License

classmethod clip_surface_with_grid(inputSurfaceFile, inputSurface, gridSurfaceFileName, gridSurfaceName, outputSurfaceFile, outputSurfaceNameAbove, outputSurfaceNameBelow, surface_clip_mode)

Clip a Surface with a Grid Surface (grid converted to surface)

Parameters:
  • inputSurfaceFile (str) – Input Geosurface file
  • inputSurface (str) – Input Surface name within Geosurface file
  • gridSurfaceFileName (str) – Grid Surface file name
  • gridSurfaceName (str) – Grid surface name within file
  • outputSurfaceFile (str) – Output Surface file
  • outputSurfaceNameAbove (str) – Name of Surface Item above grid - required for mode=CLIP_ABOVE and CLIP_BOTH
  • outputSurfaceNameBelow (str) – Name of Surface Item below grid - required for mode=CLIP_BELOW and CLIP_BOTH
  • surface_clip_mode (int) – SURFACE_CLIP_MODE constants

New in version 9.5.

License: Geosoft Open License

classmethod clip_surface_with_polygon2d(inputSurfaceFile, inputSurface, polygonFile, outputSurfaceFile, outputSurfaceName, maskInside)

Clip a Surface a specified Polygon file

Parameters:
  • inputSurfaceFile (str) – Input Geosurface file
  • inputSurface (str) – Input Surface name within Geosurface file
  • polygonFile (str) – Polygon File
  • outputSurfaceFile (str) – Output Surface file
  • outputSurfaceName (str) – Output Surface name
  • maskInside (bool) – Set true if the values inside polygon are to be masked

New in version 9.5.

License: Geosoft Open License

classmethod compute_surface_clip(primarySurfaceFile, primarySurface, secondarySurfaceFile, secondarySurface, outputSurfaceFile, outputSurface)

Clip a surface with another surface, and output the clipped surfaces

Parameters:
  • primarySurfaceFile (str) – Primary Geosurface file
  • primarySurface (str) – Primary Surface Name within Geosurface File
  • secondarySurfaceFile (str) – Secondary Geosurface file
  • secondarySurface (str) – Secondary Surface Name within Geosurface File
  • outputSurfaceFile (str) – Output surface file
  • outputSurface (str) – Output surface name

New in version 9.5.

License: Geosoft Open License

classmethod compute_surface_intersection(primarySurfaceFile, primarySurface, secondarySurfaceFile, secondarySurface, outputSurfaceFile, outputSurface)

Computes and outputs the intersection of two closed surfaces

Parameters:
  • primarySurfaceFile (str) – Primary Geosurface file
  • primarySurface (str) – Primary Surface Name within Geosurface File
  • secondarySurfaceFile (str) – Secondary Geosurface file
  • secondarySurface (str) – Secondary Surface Name within Geosurface File
  • outputSurfaceFile (str) – Output surface file
  • outputSurface (str) – Output surface name

New in version 9.5.

License: Geosoft Open License

classmethod compute_surface_simplification(inputSurfaceFile, inputSurface, outputSurfaceFile, outputSurface)

Simplifies a surface by reducing the number of edges by half

Parameters:
  • inputSurfaceFile (str) – Input Geosurface file
  • inputSurface (str) – Input Surface Name within Geosurface File
  • outputSurfaceFile (str) – Output Geosurface file
  • outputSurface (str) – Output Surface Name within Geosurface File

New in version 9.5.

License: Geosoft Open License

classmethod compute_surface_subdivision(inputSurfaceFile, inputSurface, outputSurfaceFile, outputSurface)

Smooths a surface by applying a loop subdivision algorithm

Parameters:
  • inputSurfaceFile (str) – Input Geosurface file
  • inputSurface (str) – Input Surface Name within Geosurface File
  • outputSurfaceFile (str) – Output Geosurface file
  • outputSurface (str) – Output Surface Name within Geosurface File

New in version 9.5.

License: Geosoft Open License

classmethod compute_surface_union(primarySurfaceFile, primarySurface, secondarySurfaceFile, secondarySurface, outputSurfaceFile, outputSurface)

Compute union of two surfaces

Parameters:
  • primarySurfaceFile (str) – Primary Geosurface file
  • primarySurface (str) – Primary Surface Name within Geosurface File
  • secondarySurfaceFile (str) – Secondary Geosurface file
  • secondarySurface (str) – Secondary Surface Name within Geosurface File
  • outputSurfaceFile (str) – Output surface file
  • outputSurface (str) – Output surface name

New in version 9.5.

License: Geosoft Open License

classmethod does_surface_intersect(primarySurfaceFile, primarySurface, secondarySurfaceFile, secondarySurface)

Checks if the two surfaces intersect at all

Parameters:
  • primarySurfaceFile (str) – Primary Geosurface file
  • primarySurface (str) – Primary Surface Name within Geosurface File
  • secondarySurfaceFile (str) – Secondary Geosurface file
  • secondarySurface (str) – Secondary Surface Name within Geosurface File
Returns:

Returns 1 if intersects, 0 if surfaces do not intersect
Return type:

int

New in version 9.5.

License: Geosoft Open License

classmethod does_surface_self_intersect(surfaceFile, surfaceName)

Checks if a surface self-intersects

Parameters:
  • surfaceFile (str) – Geosurface file
  • surfaceName (str) – Primary Surface Name within Geosurface File
Returns:

Returns 1 if surface self intersects, 0 if surface has no self-intersections
Return type:

int

New in version 9.5.

License: Geosoft Open License

classmethod import_grid_to_surface(grid_file_name, geosurface_filename, surface_name)

Imports a Grid to a Surface

Parameters:
  • grid_file_name (str) – Grid File Name
  • geosurface_filename (str) – Surface File Name
  • surface_name (str) – Surface Item Name within the file

New in version 9.5.

License: Geosoft Open License

is_null()

Check if this is a null (undefined) instance

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

A null (undefined) instance of GXMESHUTIL

Returns:A null GXMESHUTIL
Return type:GXMESHUTIL

SURFACE_CLIP_MODE constants

Surface Clip Mode

SURFACE_CLIP_ABOVE

Output the surface item above clipper surface

gxapi.SURFACE_CLIP_ABOVE = 0
SURFACE_CLIP_BELOW

Output the surface item below clipper surface

gxapi.SURFACE_CLIP_BELOW = 1
SURFACE_CLIP_BOTH

Output the surface items both above & below the clipper surface

gxapi.SURFACE_CLIP_BOTH = 2