GXGEOSTRING class¶

class GXGEOSTRING(handle=0)[source]¶

GXGEOSTRING class.

The GXGEOSTRING class is used to read information stored in Geostring files (*.geosoft_string). Geosoft geostrings are 3D vector files that store digitized interpretations drawn on section maps. Both polygon and polyline features can be stored in the same file. This API currently only provides read access, but read/write support could be added in the future.

__init__(handle=0)[source]¶

get_all_shapes(lst)[source]¶

Get the all shapes

Parameters:: lst (GXLST) – GXLST to fill

New in version 8.4.

License: Geosoft Open License

get_feature_properties(guid, name, description, polygon, pat_number, pat_size, pat_thick, pat_density, pat_color, pat_bg_color, line_style, line_thickness, line_pitch, line_color)[source]¶

Get a feature’s properties

Parameters:

guid (str) – Feature GUID
name (str_ref) – Name
description (str_ref) – Description
polygon (bool_ref) – Indicates if feature is described by polygons (shapes are polylines if not set)
pat_number (int_ref) – The fill pattern number (see GXMVIEW.pat_number)
pat_size (float_ref) – The fill pattern size (see GXMVIEW.pat_size)
pat_thick (float_ref) – The fill pattern thickness (see GXMVIEW.pat_thick)
pat_density (float_ref) – The fill pattern density (see GXMVIEW.pat_density)
pat_color (int_ref) – The fill color (an GXMVIEW color)
pat_bg_color (int_ref) – The fill background color (an GXMVIEW color)
line_style (int_ref) – The line style (see GXMVIEW.line_style)
line_thickness (float_ref) – The line thickness (see GXMVIEW.line_thick)
line_pitch (float_ref) – The dash pattern pitch (see GXMVIEW.line_style)
line_color (int_ref) – The line color (an GXMVIEW color)

New in version 8.4.

License: Geosoft Open License

get_features(lst)[source]¶

Get the features

Parameters:: lst (GXLST) – GXLST to fill

New in version 8.4.

License: Geosoft Open License

Note: List items are returned with feature GUID in name and feature name in value.

get_ipj(ipj)[source]¶

Get the coordinate system of the Geostring.

Parameters:: ipj (GXIPJ) – GXIPJ in which to place the Geostring coordinate system

New in version 8.4.

License: Geosoft Open License

get_section_properties(guid, name, container_name, orientation, easting, northing, elevation, azimuth, swing, a, b, c, d)[source]¶

Get a section’s properties

Parameters:

guid (str) – Section GUID
name (str_ref) – Name
container_name (str_ref) – ContainerName
orientation (int_ref) – SECTION_ORIENTATION constants
easting (float_ref) – Easting
northing (float_ref) – Northing
elevation (float_ref) – Elevation
azimuth (float_ref) – Azimuth
swing (float_ref) – Swing
a (float_ref) – A in the scalar equation of best-fit plane describing the section
b (float_ref) – B in the scalar equation of best-fit plane describing the section
c (float_ref) – C in the scalar equation of best-fit plane describing the section
d (float_ref) – D in the scalar equation of best-fit plane describing the section

New in version 8.4.

License: Geosoft Open License

get_sections(lst)[source]¶

Get the sections

Parameters:: lst (GXLST) – GXLST to fill

New in version 8.4.

License: Geosoft Open License

Note: List items are returned with section GUID in name and section name in value.

get_shape_properties(guid, feature_guid, section_guid, vert_v_vx, vert_v_vy, vert_v_vz)[source]¶

Get a shape’s properties

Parameters:

guid (str) – Shape GUID
feature_guid (str_ref) – Feature GUID
section_guid (str_ref) – Section GUID
vert_v_vx (GXVV) – Vertices X location
vert_v_vy (GXVV) – Vertices Y location
vert_v_vz (GXVV) – Vertices Z location

New in version 8.4.

License: Geosoft Open License

get_shapes_for_feature(guid, lst)[source]¶

Get all shapes linked to a specific feature

Parameters:

guid (str) – Feature GUID
lst (GXLST) – GXLST to fill

New in version 8.4.

License: Geosoft Open License

get_shapes_for_feature_and_section(feature_guid, section_guid, lst)[source]¶

Get all shapes linked to a specific feature and section

Parameters:

feature_guid (str) – Feature GUID
section_guid (str) – Section GUID
lst (GXLST) – GXLST to fill

New in version 8.4.

License: Geosoft Open License

get_shapes_for_section(guid, lst)[source]¶

Get all shapes linked to a specific section

Parameters:

guid (str) – Section GUID
lst (GXLST) – GXLST to fill

New in version 8.4.

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 GXGEOSTRING

Returns:: A null GXGEOSTRING
Return type:: GXGEOSTRING

classmethod open(geostring_file, mode)[source]¶

Open a Geostring file

Parameters:

geostring_file (str) – Geostring file name
mode (int) – GEOSTRING_OPEN constants

Returns:

GXGEOSTRING Object

Return type:

GXGEOSTRING

New in version 8.4.

License: Geosoft Open License

GEOSTRING_OPEN constants¶

Open Modes

GEOSTRING_OPEN_READ¶

Read

gxapi.GEOSTRING_OPEN_READ = 0¶

GEOSTRING_OPEN_READWRITE¶

Readwrite

gxapi.GEOSTRING_OPEN_READWRITE = 1¶

SECTION_ORIENTATION constants¶

Section orientation types

SECTION_ORIENTATION_UNKNOWN¶

Unknown

gxapi.SECTION_ORIENTATION_UNKNOWN = 0¶

SECTION_ORIENTATION_PLAN¶

Plan

gxapi.SECTION_ORIENTATION_PLAN = 1¶

SECTION_ORIENTATION_SECTION¶

Section

gxapi.SECTION_ORIENTATION_SECTION = 2¶

SECTION_ORIENTATION_CROOKED¶

Crooked

gxapi.SECTION_ORIENTATION_CROOKED = 2¶

SECTION_ORIENTATION_GMSYS¶

Gmsys

gxapi.SECTION_ORIENTATION_GMSYS = 2¶

Table of Contents

This Page

GXGEOSTRING class¶

GEOSTRING_OPEN constants¶

SECTION_ORIENTATION constants¶