GXMVU class

class geosoft.gxapi.GXMVU
A catchall library for methods using the MAP and MVIEW classes.
These include drawing flight paths, legends, postings, and
special objects such as histograms and bar charts.
static arrow((GXMVIEW)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (int)arg8) → None:
Draw an arrow.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (float) – Head X location
  • arg3 (float) – Head Y location
  • arg4 (float) – Tail X location
  • arg5 (float) – Tail Y location
  • arg6 (float) – See MVU_ARROW definitions for explanation
  • arg7 (float) – Angle of barbs with respect to the tail in degrees.
  • arg8 (int) – MVU_ARROW constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static arrow_vector_vv((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (GXVV)arg5, (float)arg6, (int)arg7, (int)arg8, (int)arg9, (int)arg10, (float)arg11) → None:
Draw arrow vectors based on input VVs.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The locations are given in two VVs, and the directions
in the two others. A wide range of sizes are available.
If the scaling is set to rDUMMY, then arrows are automatically
scaled so the largest is 1cm in length.
If the line thickness is set to rDUMMY, the line thickness scales
with the arrow size, and is 1/20 of the vector length.
static bar_chart((GXMVIEW)arg1, (str)arg2, (GXDB)arg3, (int)arg4, (str)arg5, (str)arg6, (str)arg7, (float)arg8, (str)arg9, (float)arg10, (str)arg11, (float)arg12, (float)arg13, (int)arg14, (int)arg15, (int)arg16, (int)arg17, (int)arg18, (int)arg19, (int)arg20, (float)arg21, (float)arg22, (float)arg23, (float)arg24, (float)arg25, (float)arg26, (float)arg27, (float)arg28) → None:
Plot bar chart on a map.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (str) – Group name
  • arg3 (geosoft.gxapi.GXDB) – Database handle
  • arg4 (int) – Line handle
  • arg5 (str) – Horizontal (X) axis’ channel name
  • arg6 (str) – List of channel names (comma separated)
  • arg7 (str) – X axis title
  • arg8 (float) – Text size for X axis
  • arg9 (str) – Y axis title
  • arg10 (float) – Text size for Y axis
  • arg11 (str) – Overall chart title
  • arg12 (float) – Text size for overall title
  • arg13 (float) – Bar width in mm
  • arg14 (int) – Distance based (1) or fiducial based (0)
  • arg15 (int) – BARCHART_LABEL constants
  • arg16 (int) – Draw ticks along X axis (1) or not (0)
  • arg17 (int) – Draw right vertical axis (1) or not
  • arg18 (int) – Draw top horizontal axis (1)
  • arg19 (int) – Draw bottom horizontal axis (1) or not
  • arg20 (int) – Draw surronding box (1) or not (0) The following 4 parameters are required if drawing the surronding box
  • arg21 (float) – Width in mm between left Y axis of bar chart with left surronding line
  • arg22 (float) – Width in mm between bottom X axis of bar chart with bottom surronding line
  • arg23 (float) – Width in mm between right Y axis of bar chart with right surronding line
  • arg24 (float) – Width in mm between top X axis of bar chart with top surronding line
  • arg25 (float) – X in mm (bottom left corner of bar chart)
  • arg26 (float) – Y in mm (bottom left corner of bar chart)
  • arg27 (float) – Width of the bar chart in mm
  • arg28 (float) – Height of the bar chart in mm
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static c_symb_legend((GXMVIEW)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (str)arg6, (str)arg7, (str)arg8) → None:
Plot a legend for the classified color symbols.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – MVIEW object
  • arg2 (float) – Plot origin X
  • arg3 (float) – Plot origin Y
  • arg4 (float) – Label Font size (mm)
  • arg5 (float) – Symbol scale factor
  • arg6 (str) – AGG, ITR or ZON file name
  • arg7 (str) – Plot title
  • arg8 (str) – Plot subtitle
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

If the symbol size, colour, font etc are specified in
the ITR's REG, then the Symbol scale factor is used
allow the user to adjust the symbol sizes. They will be
plotted at a size equal to the size in the REG times
the scale factor.
If no symbol size info can be found in the REG, then
the symbol size is set equal to the Label Font Size.
If no symbol font or number info is included in the
REG, it is the programmer's responsibility to select
the correct font and symbol before CSymbLegend is
called. The same is true of the edge colour.
static cdi_pixel_plot((GXMVIEW)arg1, (str)arg2, (GXVA)arg3, (GXVA)arg4, (GXVV)arg5, (GXITR)arg6) → None:
Create a colour pixel-style plot of CDI data.
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.2.0.

Note:

Draws a single coloured rectangle for each data point in
Conductivity-Depth data (for example). It is similar to the
result you get if you plot a grid with Pixel=1, but in this
data the row and column widths are not necessarily constant,
and the data can move up and down with topography. The pixels
are sized so that the boundaries are half-way between adjacent
data, both vertically and horizontally.
static cdi_pixel_plot_3d((GXMVIEW)arg1, (str)arg2, (GXVA)arg3, (GXVA)arg4, (GXVV)arg5, (GXVV)arg6, (GXITR)arg7) → None:
Create a colour pixel-style plot of CDI data in a 3D view.
Parameters:
Returns:

Nothing
Return type:

None

New in version 7.2.0.

Note:

Similar to geosoft.gxapi.GXMVU.cdi_pixel_plot(), but plotted onto a series of
plotting planes which hang from the XY path in 3D. Each vertical plane azimuth
is defined by two adjacent points on the path. The colour "pixel" for each
data point is plotted in two halves, with each half on adjacent plotting planes,
with the bend at the data point.
static color_bar((GXMVIEW)arg1, (GXITR)arg2, (int)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8) → None:
Create a Color Bar in view
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXITR) – Itr
  • arg3 (int) – decimals
  • arg4 (float) – annotation offset from box in mm.
  • arg5 (float) – box height
  • arg6 (float) – box width
  • arg7 (float) – X location (bottom left corner of colour boxes)
  • arg8 (float) – Y location
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static color_bar2((GXMVIEW)arg1, (GXITR)arg2, (GXITR)arg3, (int)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9) → None:
Create a Color Bar from two ITR
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXITR) – ITR
  • arg3 (geosoft.gxapi.GXITR) – Secondary ITR
  • arg4 (int) – decimals
  • arg5 (float) – annotation size
  • arg6 (float) – box height
  • arg7 (float) – box width
  • arg8 (float) – X location (bottom left corner of colour boxes)
  • arg9 (float) – Y location
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The secondary ITR is used to blend horizontally with the
primary ITR in each box.
static color_bar2_style((GXMVIEW)arg1, (GXITR)arg2, (GXITR)arg3, (int)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (int)arg10) → None:
Create a Color Bar from two ITRs with style options
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The secondary ITR is used to blend horizontally with the
primary ITR in each box.
static color_bar_hor((GXMVIEW)arg1, (GXITR)arg2, (int)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (int)arg9) → None:
Create a horizontal color bar in view
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXITR) – Itr
  • arg3 (int) – decimals
  • arg4 (float) – annotation offset from box in mm (negative for labels below).
  • arg5 (float) – box width in mm
  • arg6 (float) – box height in mm
  • arg7 (float) – X location (bottom left corner of colour boxes) in mm
  • arg8 (float) – Y location in mm
  • arg9 (int) – COLORBAR_LABEL constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The sign of the annotation offset determines whether labels are
plotted above or below the colorbar. Labels above are text-justified
to the bottom of the text, and labels below are text-justified to
the top of the text.

See also

geosoft.gxapi.GXMVU.color_bar()

static color_bar_hor2((GXMVIEW)arg1, (GXITR)arg2, (GXITR)arg3, (int)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (int)arg10) → None:
Create a Horizontal Color Bar from two ITRs
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.0.

Note:

The secondary ITR is used to blend horizontally with the
primary ITR in each box.
static color_bar_hor2_style((GXMVIEW)arg1, (GXITR)arg2, (GXITR)arg3, (int)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (int)arg10, (int)arg11) → None:
Create a Horizontal Color Bar from two ITRs with style options
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.0.

Note:

The secondary ITR is used to blend horizontally with the
primary ITR in each box.
static color_bar_hor_style((GXMVIEW)arg1, (GXITR)arg2, (int)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (int)arg9, (int)arg10) → None:
Create a Horizontal Color Bar in view with style options
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.0.

static color_bar_reg((GXMVIEW)arg1, (GXITR)arg2, (GXITR)arg3, (GXREG)arg4) → None:
Create a Color Bar in view
Parameters:
Returns:

Nothing
Return type:

None

New in version 8.2.

Note:

To allow for expansion, all parameters are passed inside the REG object.

BAR_ORIENTATION        one of MVU_ORIENTATION_XXX (DEFAULT = MVU_ORIENTATION_VERTICAL)
DECIMALS                                        decimals in plotted values (see sFormatStr_GS for rules) (DEFAULT = 1)
ANNOFF                                          annotation offset from bar (+/- determines side of the bar left/right and below/above)
BOX_SIZE               box height (mm) (width for horizontal colour bar) (DEFAULT = 4)
BAR_WIDTH              width (mm) (short dimension) of the colour bar (DEFAULT = 8)
MINIMUM_GAP            Minimum space between annotations, otherwise drop annotations (DEFAULT = 0 mm)
The actual height is over-estimated, so even with zero gap there will normally always be some space between labels.
FIXED_INTERVAL         Preset interval for annotations scale (DEFAULT = DUMMY, use colour zones)
FIXED_MINOR_INTERVAL   Preset minor interval for annotations scale (DEFAULT = DUMMY, if defined must be 1/10, 1/5, 1/4 or 1/2 of FIXED_INTERVAL)
X                                                               X location      (REQUIRED)
Y                                                               Y location      (REQUIRED)
POST_MAXMIN            Post limit values at ends of the bar (0 or 1)? (DEFAULT = 0)
DIVISION_STYLE         One of MVU_DIVISION_STYLE_XXX (DEFAULT = MVU_DIVISION_STYLE_LINES)
static color_bar_style((GXMVIEW)arg1, (GXITR)arg2, (int)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (int)arg9) → None:
Create a Color Bar in view with style options
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static contour((GXMVIEW)arg1, (str)arg2, (str)arg3) → None:
Creates a contour map.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static contour_ply((GXMVIEW)arg1, (GXPLY)arg2, (str)arg3, (str)arg4) → None:
Creates a contour map with clipped areas.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.1.6.

Note:

The clipping PLY can include a surrounding inclusive polygon
and zero, one or more interior exclusive polygons. Construct
a PLY object using the geosoft.gxapi.GXPLY.add_polygon_ex() function, to add both
inclusive (as the first PLY) and exclusive interior regions.
static decay_curve((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (GXVA)arg4, (GXVA)arg5, (int)arg6, (float)arg7, (float)arg8, (int)arg9, (int)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14, (float)arg15, (float)arg16, (float)arg17, (float)arg18, (float)arg19, (int)arg20, (str)arg21) → None:
Plot decay curves at survey locations
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXVV) – X coordinate VV
  • arg3 (geosoft.gxapi.GXVV) – Y coordinate VV
  • arg4 (geosoft.gxapi.GXVA) – VA channel to plot
  • arg5 (geosoft.gxapi.GXVA) – VA channel as horizontal axis (normally time channel)
  • arg6 (int) – Log option: 0 linear (default), 1 logarithm, 2 log/linear
  • arg7 (float) – Min value to apply log (must be > 0.0)
  • arg8 (float) – Angle in degrees measured CCW from East of the map
  • arg9 (int) – Draw horizontal bar: 0 none, 1 bottom, 2 top, 3 both
  • arg10 (int) – Draw vertical bar: 0 none, 1 bottom, 2 top, 3 both
  • arg11 (float) – X offset in mm: Horizontal distance between survey location and origin of the box inside which decay curvey is drawn
  • arg12 (float) – Y offset in mm
  • arg13 (float) – Box width in mm:Decay curve at each survey location is drawn within this box
  • arg14 (float) – Box height in mm
  • arg15 (float) – Minimum value for X (horizontal axis)
  • arg16 (float) – Minimum value for Y (vertical axis)
  • arg17 (float) – X scale
  • arg18 (float) – Y scale
  • arg19 (float) – Line pitch, default is 5.0mm
  • arg20 (int) – line style
  • arg21 (str) – line color
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Box width and height are used to draw horizontal and vertical
bars. Curves outside the box are not clipped.
static direction_plot((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (float)arg4, (float)arg5, (int)arg6) → None:
Plot an arrow to indicate the direction of a flight line
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

An arrow will be drawn in the direction from the first valid
to the last points in the X and Y VVs.
static em_forward((GXMVIEW)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (int)arg8, (float)arg9, (float)arg10, (float)arg11, (float)arg12, (GXVV)arg13, (GXVV)arg14, (GXVV)arg15, (GXVV)arg16, (int)arg17, (int)arg18) → None:
Plot an EM forward model against inverted data.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (float) – Plot X origin
  • arg3 (float) – Plot Y origin
  • arg4 (float) – Plot X size
  • arg5 (float) – Plot Y size
  • arg6 (float) – Coil Separation (m)
  • arg7 (float) – Coil Frequency (Hz)
  • arg8 (int) – EMLAY_GEOMETRY constants
  • arg9 (float) – Inverted or current resistivity
  • arg10 (float) – Inverted or current height
  • arg11 (float) – In-phase datum
  • arg12 (float) – Quadrature datum
  • arg13 (geosoft.gxapi.GXVV) – Forward model resistivities
  • arg14 (geosoft.gxapi.GXVV) – Forward model heights
  • arg15 (geosoft.gxapi.GXVV) – Forward model In-phase (ppm)
  • arg16 (geosoft.gxapi.GXVV) – Forward model Quadrature (ppm)
  • arg17 (int) – Plot resistivity as linear (0) or log (1)
  • arg18 (int) – Plot as function of resistivity (0) or height (1)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

This function is designed to display an inverted result beside
the forward model curves. This is useful for trouble-shooting
or understanding why a certain inversion result was obtained.
The earth model is a simple halfspace.
The forward model is plotted either as a function of
resistivity at a single height, or as a function of height at
a single resistivity. In either case, the relevant VVs must be
completely filled (even if one is all the same value).
static export_datamine_string((GXMVIEW)arg1, (GXLST)arg2, (str)arg3) → None:
Export selected map groups in a map view to a Datamine coordinate string file.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.3.0.

Note:

The lines, rectangles and polygons in the specified groups
will be exported to a Datamine coordinate string (*.dm) file.
The function attemps to duplicate the colours, etc. used.
Complex polygon objects will be exported as independent
single polygons.

See also

geosoft.gxapi.GXLST class

static export_dxf_3d((GXMVIEW)arg1, (GXLST)arg2, (GXWA)arg3) → None:
Export selected map groups in a map view to an AutoCAD 3D DXF file.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.2.0.

Note:

Supported objects exported include lines, polygons, text.

See also

geosoft.gxapi.GXLST class

static export_surpac_str((GXMVIEW)arg1, (GXLST)arg2, (GXWA)arg3, (GXWA)arg4) → None:
Export selected map groups in a map view to a Surpac STR file.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.2.0.

Note:

The lines, rectangles and polygons in the specified groups
will be exported to a Surpac STR file. An accompanying styles
file will be created which will attempt to duplicate the
colours, etc. used.
Complex polygon objects will be exported as independent
single polygons.

See also

geosoft.gxapi.GXLST class

static exportable_dxf_3d_groups_lst((GXMVIEW)arg1, (GXLST)arg2) → int:
Return a LST of groups you can export using sExportDXF3D_MVU.
Parameters:
Returns:

The number of groups in the LST.
Return type:

int

New in version 7.1.0.

Note:

Returns a list of visible groups that the DXF 3D export can
export. Removes things like VOXD, AGG, and target
groups starting with "Dh", which are typically plotted in 3D
views on a reference plan oriented toward the user, and thus
not exportable.
static flight_plot((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (str)arg4, (int)arg5, (float)arg6, (int)arg7, (float)arg8, (float)arg9) → None:
Draw a flight line
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXVV) – X
  • arg3 (geosoft.gxapi.GXVV) – Y
  • arg4 (str) – line label
  • arg5 (int) – MVU_FLIGHT_LOCATE constants
  • arg6 (float) – lines steeper than this angle are considered vertical and the up label direction is used.
  • arg7 (int) – up label direction: 1 up is right, -1 up is left
  • arg8 (float) – along line label offset in mm.
  • arg9 (float) – perpendicular label offset mm.
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Current line color, thickness and style are used to
draw the line.

Current font, font colour and font style are used to
annotate the line labels.

If current clipping is ON in the VIEW, lines will be
clipped to the window before plotting.  In this case,
labels should be located ABOVE or BELOW the line
traces to prevent labels being clipped.

The offsets dOffA and dOffB control the vertical and
horizontal label offsets with respect to the ends of
the line trace and depending on the label location.

The vertical line reference angle dVerAng is used
to determine if lines are considered vertical or
horizontal.  Vertical lines use the sUp parameter
to determine the label up direction.  Normally, use an
angle of 60 degrees unless there are lines that run in
this direction.

See also

geosoft.gxapi.GXMVU.path_plot()

static gen_areas((GXMVIEW)arg1, (str)arg2, (GXVV)arg3, (GXVV)arg4, (float)arg5) → None:
Generate areas from an line group.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The specified line group will be used to create a new group that
is composed of all the resolved polygonal areas in the line group.
Each polygonal area is assigned a colour/pattern as specified in the
colour and pattern VV's.  Colour/patterns are assigned in rotating
sequence.

See also

geosoft.gxapi.GXMVU.re_gen_areas()

static generate_surface_from_voxel((GXMVIEW)arg1, (GXVOX)arg2, (int)arg3, (int)arg4, (float)arg5, (float)arg6, (int)arg7, (float)arg8, (float)arg9, (str)arg10) → None:
TODO...
Parameters:
Returns:

Nothing
Return type:

None

New in version 8.5.0.

Note:

TODO... Move to VOX method for surface generation only and use GeosurfaceD to display.
static get_range_gocad_surface((str)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6, (float_ref)arg7) → None:
Get the XYZ range of a GOCAD surface.
Parameters:
Returns:

Nothing
Return type:

None

New in version 6.4.0.

Note:

Required to set up a map view before doing the actual
surface import.
static histogram((GXMVIEW)arg1, (GXST)arg2, (GXST)arg3, (str)arg4, (str)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (float)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14, (int)arg15, (int)arg16, (int)arg17, (GXST)arg18) → None:
Plot the histogram on a map.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXST) – ST with summary stats of original data
  • arg3 (geosoft.gxapi.GXST) – ST with histogram info of original or log10 data
  • arg4 (str) – Title
  • arg5 (str) – unit
  • arg6 (float) – X in mm (bottom left corner of histogram box)
  • arg7 (float) – Y in mm (bottom left corner of histogram box)
  • arg8 (float) – box width in mm
  • arg9 (float) – box height in mm
  • arg10 (float) – Minimum X in data unit (bottom left corner of histogram boxes)
  • arg11 (float) – Minimum Y in data unit
  • arg12 (float) – box width in data unit
  • arg13 (float) – box height in data unit
  • arg14 (float) – width (mm) of the additional box for summary stats
  • arg15 (int) – Log horizontal axis: 0 - Normal, 1 - Log
  • arg16 (int) – Summary stats: 0 - do not draw, 1 - draw
  • arg17 (int) – Fill color
  • arg18 (geosoft.gxapi.GXST) – ST with histogram for box-whisker plot (-1 for no plot)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

This function just calls geosoft.gxapi.GXMVU.histogram2() with decimals set
to -7 (7 significant figures).

See also

geosoft.gxapi.GXMVU.histogram2(), geosoft.gxapi.GXMVU.histogram3()

static histogram2((GXMVIEW)arg1, (GXST)arg2, (GXST)arg3, (str)arg4, (str)arg5, (float)arg6, (str)arg7, (float)arg8, (str)arg9, (float)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14, (float)arg15, (float)arg16, (float)arg17, (float)arg18, (int)arg19, (int)arg20, (int)arg21, (GXST)arg22, (float)arg23) → None:
Plot the histogram on a map.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXST) – ST with summary stats of original data
  • arg3 (geosoft.gxapi.GXST) – ST with histogram info of original or log10 data
  • arg4 (str) – X axis title
  • arg5 (str) – Y axis title
  • arg6 (float) – Text size in mm for X/Y axis’ titles. Accept dummy
  • arg7 (str) – Overall title. Plotted below X axis if X axis title is not given
  • arg8 (float) – Text size in mm for plot overall title. Accept dummy
  • arg9 (str) – unit
  • arg10 (float) – X in mm (bottom left corner of histogram box)
  • arg11 (float) – Y in mm (bottom left corner of histogram box)
  • arg12 (float) – box width in mm
  • arg13 (float) – box height in mm
  • arg14 (float) – Minimum X in data unit (bottom left corner of histogram boxes)
  • arg15 (float) – Minimum Y in data unit
  • arg16 (float) – box width in data unit
  • arg17 (float) – box height in data unit
  • arg18 (float) – width (mm) of the additional box for summary stats
  • arg19 (int) – Log horizontal axis: 0 - Normal, 1 - Log
  • arg20 (int) – Summary stats: 0 - do not draw, 1 - draw
  • arg21 (int) – Fill color
  • arg22 (geosoft.gxapi.GXST) – ST with histogram for box-wisker plot (-1 for no plot)
  • arg23 (float) – X value (threshold value) to draw a vertical line (see notes)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

A vertical line through from bottom to top horizontal axis is drawn
Also a label 'Threshold value' is plotted against this line. However,
None of them will be plotted if threshold value is dummy or outside
the X data range.
static histogram3((GXMVIEW)arg1, (GXST)arg2, (GXST)arg3, (str)arg4, (str)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (float)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14, (int)arg15, (int)arg16, (int)arg17, (int)arg18, (int)arg19, (GXST)arg20) → None:
Plot the histogram on a map, specify decimals.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXST) – ST with summary stats of original data
  • arg3 (geosoft.gxapi.GXST) – ST with histogram info of original or log10 data
  • arg4 (str) – Title
  • arg5 (str) – unit
  • arg6 (float) – X in mm (bottom left corner of histogram box)
  • arg7 (float) – Y in mm (bottom left corner of histogram box)
  • arg8 (float) – box width in mm
  • arg9 (float) – box height in mm
  • arg10 (float) – Minimum X in data unit (bottom left corner of histogram boxes)
  • arg11 (float) – Minimum Y in data unit
  • arg12 (float) – box width in data unit
  • arg13 (float) – box height in data unit
  • arg14 (float) – width (mm) of the additional box for summary stats
  • arg15 (int) – Log horizontal axis: 0 - Normal, 1 - Log
  • arg16 (int) – Summary stats: 0 - do not draw, 1 - draw
  • arg17 (int) – Fill color
  • arg18 (int) – Decimals for data, negative for sig. fig.
  • arg19 (int) – Decimals for stats, negative for sig. fig.
  • arg20 (geosoft.gxapi.GXST) – ST with histogram for box-whisker plot (-1 for no plot)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static histogram4((GXMVIEW)arg1, (GXST)arg2, (GXST)arg3, (str)arg4, (str)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (float)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14, (int)arg15, (int)arg16, (int)arg17, (int)arg18, (int)arg19, (int)arg20, (GXST)arg21) → None:
As geosoft.gxapi.GXMVU.histogram3(), but allow probability scaling of percents.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXST) – ST with summary stats of original data
  • arg3 (geosoft.gxapi.GXST) – ST with histogram info of original or log10 data
  • arg4 (str) – Title
  • arg5 (str) – unit
  • arg6 (float) – X in mm (bottom left corner of histogram box)
  • arg7 (float) – Y in mm (bottom left corner of histogram box)
  • arg8 (float) – box width in mm
  • arg9 (float) – box height in mm
  • arg10 (float) – Minimum X in data unit (bottom left corner of histogram boxes)
  • arg11 (float) – Minimum Y in data unit
  • arg12 (float) – box width in data unit
  • arg13 (float) – box height in data unit
  • arg14 (float) – width (mm) of the additional box for summary stats
  • arg15 (int) – Log horizontal axis: 0 - Normal, 1 - Log
  • arg16 (int) – Summary stats: 0 - do not draw, 1 - draw
  • arg17 (int) – Probability scaling: 0 - linear scale, 1 - scale as normal distribution
  • arg18 (int) – Fill color
  • arg19 (int) – Decimals for data, negative for sig. fig.
  • arg20 (int) – Decimals for stats, negative for sig. fig.
  • arg21 (geosoft.gxapi.GXST) – ST with histogram for box-whisker plot (-1 for no plot)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static histogram5((GXMVIEW)arg1, (GXST)arg2, (GXST)arg3, (str)arg4, (str)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (float)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14, (float)arg15, (int)arg16, (int)arg17, (int)arg18, (int)arg19, (int)arg20, (int)arg21, (GXST)arg22, (GXITR)arg23) → None:
As geosoft.gxapi.GXMVU.histogram4(), but allow ITR to colour bars.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXST) – ST with summary stats of original data
  • arg3 (geosoft.gxapi.GXST) – ST with histogram info of original or log10 data
  • arg4 (str) – Title
  • arg5 (str) – unit
  • arg6 (float) – [i] Lambda Value
  • arg7 (float) – X in mm (bottom left corner of histogram box)
  • arg8 (float) – Y in mm (bottom left corner of histogram box)
  • arg9 (float) – box width in mm
  • arg10 (float) – box height in mm
  • arg11 (float) – Minimum X in data unit (bottom left corner of histogram boxes)
  • arg12 (float) – Minimum Y in data unit
  • arg13 (float) – box width in data unit
  • arg14 (float) – box height in data unit
  • arg15 (float) – width (mm) of the additional box for summary stats
  • arg16 (int) – Log horizontal axis: 0 - Normal, 1 - Log, 2 - Lambda
  • arg17 (int) – Summary stats: 0 - do not draw, 1 - draw
  • arg18 (int) – Probability scaling: 0 - linear scale, 1 - scale as normal distribution
  • arg19 (int) – Fill color
  • arg20 (int) – Decimals for data, negative for sig. fig.
  • arg21 (int) – Decimals for stats, negative for sig. fig.
  • arg22 (geosoft.gxapi.GXST) – ST with histogram for box-whisker plot (-1 for no plot)
  • arg23 (geosoft.gxapi.GXITR) – ITR to colour bars.
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The ITR can be empty (but must still be a valid ITR object).
static import_gocad_surface((GXMVIEW)arg1, (str)arg2, (int)arg3) → None:
Import and plot a GOCAD surface model.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (str) – GOCAD file name
  • arg3 (int) – Color to plot (C_TRANSPARENT to use file-defined colour).
Returns:

Nothing
Return type:

None

New in version 6.4.0.

Note:

The vertex normals are not included in the
GOCAD import, but are calculated using
the normal of each defined triangle, and taking the
average when vertex is shared among more than one triangle.
static load_plot((GXMAP)arg1, (str)arg2) → None:
Load a Geosoft PLT file into a MAP.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static map_from_plt((GXMAP)arg1, (str)arg2, (str)arg3, (str)arg4, (float)arg5, (float)arg6) → None:
Creates a new map from a PLT file.
Parameters:
  • arg1 (geosoft.gxapi.GXMAP) – MAP Handle
  • arg2 (str) – Name to use for the base map view
  • arg3 (str) – Name to use for the data view
  • arg4 (str) – Plot file name
  • arg5 (float) – Map paper size in X direction (cm)
  • arg6 (float) – Map paper size in Y direction (cm)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

This only creates a map, it does not read the PLT into
the map.  The base view and data view will be the same
size.

See also

geosoft.gxapi.GXMVU.load_plot()

static map_mdf((GXMAP)arg1, (str)arg2, (str)arg3) → None:
Creates an MDF from a Map.
Parameters:
  • arg1 (geosoft.gxapi.GXMAP) – MAP Handle
  • arg2 (str) – MDF file name
  • arg3 (str) – Data view name
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static mapset((GXMAP)arg1, (str)arg2, (str)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (str)arg8, (int)arg9, (int)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14, (float)arg15, (float)arg16, (float)arg17) → None:
Creates a new map directly from parameters.
Parameters:
  • arg1 (geosoft.gxapi.GXMAP) – MAP Handle
  • arg2 (str) – Name to use for the base map view
  • arg3 (str) – Name to use for the data view
  • arg4 (float) – Minimum X of data area (data units)
  • arg5 (float) – Maximum X of data area (data units)
  • arg6 (float) – Minimum Y of data area (data units)
  • arg7 (float) – Maximum Y of data area (data units)
  • arg8 (str) – Media size as a string ‘x_cm,y_cm’, or a standard paper size (e.g. ‘A4’, ‘E’)
  • arg9 (int) – 0 - landscape; 1 - portrait
  • arg10 (int) – 1 - map size fixed to media; 0 - map size adjusted to data and margins.
  • arg11 (float) – Map scale (rDummy for default)
  • arg12 (float) – Conversion factor (to units/meter) (rDummy for default)
  • arg13 (float) – left margin (cm)
  • arg14 (float) – right margin (cm)
  • arg15 (float) – bottom margin (cm)
  • arg16 (float) – top margin (cm)
  • arg17 (float) – Inside data margin (cm)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static mapset2((GXMAP)arg1, (str)arg2, (str)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (str)arg8, (int)arg9, (int)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14, (float)arg15, (float)arg16, (float)arg17, (float)arg18) → None:
Same as geosoft.gxapi.GXMVU.mapset(), with vertical exaggeration.
Parameters:
  • arg1 (geosoft.gxapi.GXMAP) – MAP Handle
  • arg2 (str) – Name to use for the base map view
  • arg3 (str) – Name to use for the data view
  • arg4 (float) – Minimum X of data area (data units)
  • arg5 (float) – Maximum X of data area (data units)
  • arg6 (float) – Minimum Y of data area (data units)
  • arg7 (float) – Maximum Y of data area (data units)
  • arg8 (str) – Media size as a string ‘x_cm,y_cm’, or a standard paper size (e.g. ‘A4’, ‘E’)
  • arg9 (int) – 0 - landscape; 1 - portrait
  • arg10 (int) – 1 - map size fixed to media; 0 - map size adjusted to data and margins.
  • arg11 (float) – Map scale (rDummy for default)
  • arg12 (float) – Vertical Exaggeration (1.0 for none)
  • arg13 (float) – Conversion factor (to units/meter) (rDummy for default)
  • arg14 (float) – left margin (cm)
  • arg15 (float) – right margin (cm)
  • arg16 (float) – bottom margin (cm)
  • arg17 (float) – top margin (cm)
  • arg18 (float) – Inside data margin (cm)
Returns:

Nothing
Return type:

None

New in version 8.3.0.

static mapset2_test((float)arg1, (float)arg2, (float)arg3, (float)arg4, (str)arg5, (int)arg6, (int)arg7, (float_ref)arg8, (float)arg9, (float)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14, (float)arg15) → bool:
Test function to ensure parameters to geosoft.gxapi.GXMVU.mapset() is sane
Parameters:
  • arg1 (float) – Minimum X of data area (data units)
  • arg2 (float) – Maximum X of data area (data units)
  • arg3 (float) – Minimum Y of data area (data units)
  • arg4 (float) – Maximum Y of data area (data units)
  • arg5 (str) – Media size as a string ‘x_cm,y_cm’, or a standard paper size (e.g. ‘A4’, ‘E’)
  • arg6 (int) – 0 - landscape; 1 - portrait
  • arg7 (int) – 1 - map size fixed to media; 0 - map size adjusted to data and margins.
  • arg8 (geosoft.gxapi.float_ref) – Map scale (rDummy for default)
  • arg9 (float) – Vertical exaggeration (Normally 1.0)
  • arg10 (float) – Conversion factor (to units/meter) (rDummy for default)
  • arg11 (float) – left margin (cm)
  • arg12 (float) – right margin (cm)
  • arg13 (float) – bottom margin (cm)
  • arg14 (float) – top margin (cm)
  • arg15 (float) – Inside data margin (cm)
Returns:

bool TRUE if the parameters are good.
Return type:

bool

New in version 8.3.0.

Note:

Same as geosoft.gxapi.GXMVU.mapset_test(), with vertical exaggeration.
static mapset_test((float)arg1, (float)arg2, (float)arg3, (float)arg4, (str)arg5, (int)arg6, (int)arg7, (float_ref)arg8, (float)arg9, (float)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14) → bool:
Test function to ensure parameters to geosoft.gxapi.GXMVU.mapset() is sane
Parameters:
  • arg1 (float) – Minimum X of data area (data units)
  • arg2 (float) – Maximum X of data area (data units)
  • arg3 (float) – Minimum Y of data area (data units)
  • arg4 (float) – Maximum Y of data area (data units)
  • arg5 (str) – Media size as a string ‘x_cm,y_cm’, or a standard paper size (e.g. ‘A4’, ‘E’)
  • arg6 (int) – 0 - landscape; 1 - portrait
  • arg7 (int) – 1 - map size fixed to media; 0 - map size adjusted to data and margins.
  • arg8 (geosoft.gxapi.float_ref) – Map scale (rDummy for default)
  • arg9 (float) – Conversion factor (to units/meter) (rDummy for default)
  • arg10 (float) – left margin (cm)
  • arg11 (float) – right margin (cm)
  • arg12 (float) – bottom margin (cm)
  • arg13 (float) – top margin (cm)
  • arg14 (float) – Inside data margin (cm)
Returns:

bool TRUE if the parameters are good.
Return type:

bool

New in version 6.3.0.

Note:

Use geosoft.gxapi.GXSYS.show_error() to display errors that may have been encountered. This function can also be used
to calculate the default scale without creating a map.
static mdf((GXMAP)arg1, (str)arg2, (str)arg3, (str)arg4) → None:
Creates a new map from an MDF file.
Parameters:
  • arg1 (geosoft.gxapi.GXMAP) – MAP Handle
  • arg2 (str) – MDF file name
  • arg3 (str) – Name to use for the base map view
  • arg4 (str) – Name to use for the data view
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static path_plot((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (str)arg4, (int)arg5, (float)arg6, (int)arg7, (float)arg8, (float)arg9, (float)arg10) → None:
Draw a flight line
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXVV) – X
  • arg3 (geosoft.gxapi.GXVV) – Y
  • arg4 (str) – line label
  • arg5 (int) – MVU_FLIGHT_LOCATE constants
  • arg6 (float) – lines steeper than this angle are considered vertical and the up label direction is used.
  • arg7 (int) – up label direction: 1 up is right -1 up is left
  • arg8 (float) – along line label offset in mm.
  • arg9 (float) – perpendicular label offset mm.
  • arg10 (float) – maximum gap before breaking line, 0.0 for no breaks.
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

See geosoft.gxapi.GXMVU.flight_plot().  This is the same except for the
additional line gap parameter.

See also

FlighPlot_MVU

static path_plot_ex((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (str)arg4, (int)arg5, (int)arg6, (float)arg7, (int)arg8, (float)arg9, (float)arg10, (float)arg11) → None:
Draw a flight line
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

This is the same except for the additional line compass parameter.

See also

geosoft.gxapi.GXMVU.path_plot()

static path_plot_ex2((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (str)arg4, (int)arg5, (int)arg6, (float)arg7, (int)arg8, (float)arg9, (float)arg10, (float)arg11, (int)arg12) → None:
Draw a flight line
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.8.

Note:

This is the same except for the additional line dummies parameter.

See also

geosoft.gxapi.GXMVU.path_plot_ex()

static plot_voxel_surface((GXMVIEW)arg1, (GXVOX)arg2, (float)arg3, (int)arg4, (float)arg5) → None:
Extract an iso-surface from a voxel and plot it to a 2D or 3D view.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXVOX) – Voxel model
  • arg3 (float) – Iso-surface value
  • arg4 (int) – Drawing colour
  • arg5 (float) – Line thickness for line drawing, and 2D views.
Returns:

Nothing
Return type:

None

New in version 6.4.0.

Note:

The Marching Cubes method of Lorensen and Cline, Computer Graphics, V21,
Number 4, July 1987, is used to calculate a given iso-surface in a voxel
model. The resulting surface is plotted to a 2D or 3D view. If the view
is 2-D, then only the intersection of the surface with the 2D surface is
plotted, using lines.
static plot_voxel_surface2((GXMVIEW)arg1, (GXVOX)arg2, (float)arg3, (int)arg4, (float)arg5, (float)arg6, (str)arg7) → None:
Extract an iso-surface from a voxel and plot it to a 2D or 3D view.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXVOX) – Voxel model
  • arg3 (float) – Iso-surface value
  • arg4 (int) – Drawing colour
  • arg5 (float) – Line thickness for line drawing, and 2D views.
  • arg6 (float) – Transparency (0 - transparent, 1 - opaque).
  • arg7 (str) – Iso-surface name
Returns:

Nothing
Return type:

None

New in version 7.3.0.

Note:

The Marching Cubes method of Lorensen and Cline, Computer Graphics, V21,
Number 4, July 1987, is used to calculate a given iso-surface in a voxel
model. The resulting surface is plotted to a 2D or 3D view. If the view
is 2-D, then only the intersection of the surface with the 2D surface is
plotted, using lines.
static post((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (bool)arg5, (int)arg6, (int)arg7, (int)arg8, (int)arg9, (float)arg10) → None:
Post values on a map.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static post_ex((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (GXVV)arg5, (bool)arg6, (float)arg7, (float)arg8, (int)arg9, (int)arg10, (int)arg11, (float)arg12, (float)arg13, (int)arg14, (float)arg15, (int)arg16, (float)arg17, (int)arg18, (float)arg19, (int)arg20) → None:
Post values on a map with more paramters.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXVV) – X locations
  • arg3 (geosoft.gxapi.GXVV) – Y locations
  • arg4 (geosoft.gxapi.GXVV) – Values to post
  • arg5 (geosoft.gxapi.GXVV) – Station
  • arg6 (bool) – Do not plot dummy values? bool
  • arg7 (float) – Base to remove, default is 0.0
  • arg8 (float) – detection limit, can be GS_R8DM
  • arg9 (int) – Numb Size
  • arg10 (int) – Format
  • arg11 (int) – Decimals
  • arg12 (float) – Offset along line (right and above are positive)
  • arg13 (float) – Offset perpendicular to line
  • arg14 (int) – TRUE - Positive above, Negative below FALSE - All above.
  • arg15 (float) – Modulas on station vv
  • arg16 (int) – Reference point number
  • arg17 (float) – Text angle (degree, CCW from down-line)
  • arg18 (int) – Fixed angle ?
  • arg19 (float) – vertical reference angle
  • arg20 (int) – 1 up is right, -1 up is left
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static probability((GXMVIEW)arg1, (GXST)arg2, (GXST)arg3, (str)arg4, (str)arg5, (int)arg6, (float)arg7, (float)arg8, (float)arg9, (float)arg10, (float)arg11, (float)arg12, (float)arg13, (float)arg14, (int)arg15, (int)arg16, (int)arg17, (GXITR)arg18) → None:
Plot a probability plot on a map.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXST) – ST with summary stats of original data
  • arg3 (geosoft.gxapi.GXST) – ST with histogram info of original or log10 data
  • arg4 (str) – Title
  • arg5 (str) – unit
  • arg6 (int) – Transform type (0: Raw, 1: Log, 2: Lambda)
  • arg7 (float) – Lambda Value for lambda transform
  • arg8 (float) – X in mm (bottom left corner of histogram box)
  • arg9 (float) – Y in mm (bottom left corner of histogram box)
  • arg10 (float) – box width in mm
  • arg11 (float) – box height in mm
  • arg12 (float) – symbol size in mm
  • arg13 (float) – Sigma (X range is -sigma to sigma)
  • arg14 (float) – width (mm) of the additional box for summary stats
  • arg15 (int) – Summary stats: 0 - do not draw, 1 - draw
  • arg16 (int) – Decimals for data, negative for sig. fig.
  • arg17 (int) – Decimals for stats, negative for sig. fig.
  • arg18 (geosoft.gxapi.GXITR) – ITR to colour symbols.
Returns:

Nothing
Return type:

None

New in version 5.1.8.

Note:

The ITR can be empty (but must still be a valid ITR object).
static profile_plot((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (float)arg5, (int)arg6, (float)arg7, (float)arg8, (float)arg9, (int)arg10) → None:
Draw a profile along line trace
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXVV) – X
  • arg3 (geosoft.gxapi.GXVV) – Y
  • arg4 (geosoft.gxapi.GXVV) – Z
  • arg5 (float) – lines steeper than this angle are considered vertical and the up label direction is used.
  • arg6 (int) – up label direction: 1 up is right -1 up is left
  • arg7 (float) – Maximum gap in data to span (view units)
  • arg8 (float) – Z profile base, rDUMMY to use data minimum
  • arg9 (float) – Z scale in view units/Z unit
  • arg10 (int) – 1 to join profile to line ends.
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Profiles will be drawn in the current line style.
static profile_plot_ex((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (float)arg5, (int)arg6, (float)arg7, (float)arg8, (float)arg9, (int)arg10, (int)arg11, (float)arg12, (int)arg13, (str)arg14, (str)arg15) → None:
Draw a profile along line trace with more parameters
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXVV) – X
  • arg3 (geosoft.gxapi.GXVV) – Y
  • arg4 (geosoft.gxapi.GXVV) – Z
  • arg5 (float) – lines steeper than this angle are considered vertical and the up label direction is used.
  • arg6 (int) – up label direction: 1 up is right -1 up is left
  • arg7 (float) – Maximum gap in data to span (view units)
  • arg8 (float) – Z profile base, rDUMMY to use data minimum
  • arg9 (float) – Z scale in view units/Z unit
  • arg10 (int) – 1 to join profile to line ends.
  • arg11 (int) – Log option: 0 linear (default), 1 logarithm, 2 log/linear
  • arg12 (float) – Log base
  • arg13 (int) – Smooth curve option: 0 no (default), 1 yes
  • arg14 (str) – positive fill color
  • arg15 (str) – negative fill color
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Profiles will be drawn in the current line style.
static prop_symb_legend((GXMVIEW)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (int)arg7, (float)arg8, (float)arg9, (str)arg10, (str)arg11) → None:
Draw a legend for proportional symbols.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – MVIEW object
  • arg2 (float) – Plot origin X
  • arg3 (float) – Plot origin Y
  • arg4 (float) – Label Font size (mm)
  • arg5 (float) – Symbol scale factor (data value/mm)
  • arg6 (float) – Base value to remove before scaling
  • arg7 (int) – Number of symbols
  • arg8 (float) – Starting symbol data value (>= Base value)
  • arg9 (float) – Data value increment (>0.0)
  • arg10 (str) – Plot title
  • arg11 (str) – Plot subtitle
Returns:

Nothing
Return type:

None

New in version 5.0.8.

Note:

All symbol attributes, except for the size, are assumed
to be defined (or defaults are used).
Spacing is based on the maximum of the largest plotted symbol
and the font size.
static re_gen_areas((GXMVIEW)arg1, (str)arg2) → None:
Re-Generate from a line group and existing area group
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The area group must exist and will be modified to match the current
line group.

All non-polygon entities in the current area group will remain in the
new area group.  All existing polygon groups will be used to determine
the most likely attributes for the new polygon groups.

There must be existing polygon groups in the area group.

See also

geosoft.gxapi.GXMVU.gen_areas()

static symb_off((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (float)arg5, (float)arg6) → None:
Draws symbols with an offset and against a flag channel
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Symbols are not plotted for positions where the flag VV
value is 0 or iDUMMY.
static text_box((GXMVIEW)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (str)arg6, (float)arg7, (int)arg8) → None:
Draw a wrapped text box
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (float) – Min X
  • arg3 (float) – Min Y
  • arg4 (float) – Max X
  • arg5 (float) – Max Y
  • arg6 (str) – text
  • arg7 (float) – line spacing (1.2 good)
  • arg8 (int) – MVU_TEXTBOX constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static tick((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8) → None:
Draw line ticks on a map.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static tick_ex((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9) → None:
Same as geosoft.gxapi.GXMVU.tick(), with gap allowance.
Parameters:
  • arg1 (geosoft.gxapi.GXMVIEW) – View
  • arg2 (geosoft.gxapi.GXVV) – X locations
  • arg3 (geosoft.gxapi.GXVV) – Y locations
  • arg4 (geosoft.gxapi.GXVV) – Station
  • arg5 (float) – Tick size
  • arg6 (float) – Tick modulus on station vv
  • arg7 (float) – Major tick size
  • arg8 (float) – Major tick modulus on station vv
  • arg9 (float) – Maximum gap to span; set to 0 or rDUMMY to ignore all gaps.
Returns:

Nothing
Return type:

None

New in version 6.3.0.

static trnd_path((GXMVIEW)arg1, (GXVV)arg2, (GXVV)arg3, (int)arg4, (float)arg5) → None:
Plot min and max trend lines.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Trend lines positions consist of X and Y VVs
interspersed with dummies, which separate the
individual trend sections.
Set the minimum number of sections to > 0 to
plot only the longer trend lines.
(The number of sections in one trend section is
equal to the number of points between dummies minus one.)
Set the minimum distance to > 0 to
plot only the longer trend lines.

EMLAY_GEOMETRY constants

Type of Geometry
gxapi.EMLAY_V_COPLANAR = 0
0
gxapi.EMLAY_H_COPLANAR = 1
1
gxapi.EMLAY_V_COAXIAL = 2
2

ARROW_ALIGNMENT constants

Direction of alignment
gxapi.ARROW_ALIGNMENT_HORIZONTAL = 0
gxapi.ARROW_ALIGNMENT_VERTICAL = 1

BARCHART_LABEL constants

Place to draw bar labels
gxapi.BARCHART_LABEL_NO = 0
No label
gxapi.BARCHART_LABEL_BELOWX = 1
Label below X axis
gxapi.BARCHART_LABEL_ABOVEX = 2
Label above X axis
gxapi.BARCHART_LABEL_PEND = 3
Label at positive end of bar
gxapi.BARCHART_LABEL_NEND = 4
Label at negative end of bar
gxapi.BARCHART_LABEL_ALTERNAT1 = 5
Label at alternative ends,1st label at positive end
gxapi.BARCHART_LABEL_ALTERNAT2 = 6
Label at alternative ends,1st label at negative end

COLORBAR_LABEL constants

Label text orientation
gxapi.COLORBAR_LABEL_HORIZONTAL = 0
(default)
gxapi.COLORBAR_LABEL_VERTICAL = 1
Gives text an orientation of -90 degrees

COLORBAR_STYLE constants

Label text orientation
gxapi.COLORBAR_STYLE_NONE = 0
Don't draw
gxapi.COLORBAR_STYLE_MAXMIN = 1
Post max/min values

MVU_ORIENTATION constants

Orientation (of whatever)
gxapi.MVU_ORIENTATION_VERTICAL = 0
Vertical
gxapi.MVU_ORIENTATION_HORIZONTAL = 1
Horizontal

MVU_DIVISION_STYLE constants

Orientation (of whatever)
gxapi.MVU_DIVISION_STYLE_NONE = 0
No division marks
gxapi.MVU_DIVISION_STYLE_LINES = 1
Division line
gxapi.MVU_DIVISION_STYLE_TICS = 2
Inside tics, both sides

MVU_ARROW constants

Type Arrow. These definitions are used as binary flags, and can be
used together by passing sums.
gxapi.MVU_ARROW_SOLID = 1
Plot the head as a solid triangle, otherwise plot a "stick arrow"
with three lines for the tail and two barbs.
gxapi.MVU_ARROW_FIXED = 2
If used, input the actual length of the barbs on the arrow, in
view X-axis units, as measured along the tail. If not used, enter the ratio
between the length of the barbs and full length of the arrow (e.g. 0.4).
In the latter case, the longer the arrow, the bigger the arrow head.

MVU_FLIGHT_COMPASS constants

Compass direction
gxapi.MVU_FLIGHT_COMPASS_NONE = -1
gxapi.MVU_FLIGHT_COMPASS_EAST = 0
gxapi.MVU_FLIGHT_COMPASS_NORTH = 1
gxapi.MVU_FLIGHT_COMPASS_WEST = 2
gxapi.MVU_FLIGHT_COMPASS_SOUTH = 3

MVU_FLIGHT_DUMMIES constants

Show Dummies
gxapi.MVU_FLIGHT_DUMMIES_NOTINCLUDED = 0
gxapi.MVU_FLIGHT_DUMMIES_INCLUDED = 1

MVU_FLIGHT_LOCATE constants

Line label locations
gxapi.MVU_FLIGHT_LOCATE_NONE = 0
No label
gxapi.MVU_FLIGHT_LOCATE_END = 1
L100.2 -------------------------- L100.2

dOffA controls distance from label to line.
dOffB controls verical offset from center.
gxapi.MVU_FLIGHT_LOCATE_ABOVE = 2
L100.2                            L100.2
----------------------------------------

dOffA controls label distance above the line.
dOffB controls offset in from line end.
gxapi.MVU_FLIGHT_LOCATE_BELOW = 3
----------------------------------------
L100.2                            L100.2

dOffA controls label distance below the line.
dOffB controls offset in from line end.
gxapi.MVU_FLIGHT_DIRECTION = 8
To add '>' to label to indicate direction, for example:
MVU_FLIGHT_LOCATE_END+MVU_FLIGHT_DIRECTION

MVU_VOX_SURFACE_METHOD constants

TODO
gxapi.MVU_VOX_SURFACE_METHOD_MARCHING_CUBES = 0

MVU_VOX_SURFACE_OPTION constants

TODO
gxapi.MVU_VOX_SURFACE_OPTION_OPEN = 0
gxapi.MVU_VOX_SURFACE_OPTION_CLOSED = 1

MVU_TEXTBOX constants

Type of Box
gxapi.MVU_TEXTBOX_LEFT = 0
gxapi.MVU_TEXTBOX_CENTER = 1
gxapi.MVU_TEXTBOX_RIGHT = 2

MVU_VPOINT constants

Head Acuteness
gxapi.MVU_VPOINT_SHARP = 0
gxapi.MVU_VPOINT_MEDIUM = 1
gxapi.MVU_VPOINT_BLUNT = 2

MVU_VPOS constants

Head Position
gxapi.MVU_VPOS_HEAD = 0
gxapi.MVU_VPOS_MIDDLE = 1
gxapi.MVU_VPOS_TAIL = 2

MVU_VSIZE constants

Head Size
gxapi.MVU_VSIZE_NOHEAD = 0
gxapi.MVU_VSIZE_SMALLHEAD = 1
gxapi.MVU_VSIZE_MEDIUMHEAD = 2
gxapi.MVU_VSIZE_LARGEHEAD = 3
gxapi.MVU_VSIZE_NOTAIL = 4

MVU_VSTYLE constants

Head Style
gxapi.MVU_VSTYLE_LINES = 0
gxapi.MVU_VSTYLE_BARB = 1
gxapi.MVU_VSTYLE_TRIANGLE = 2