GXMVG class

class GXMVG(handle=0)[source]

GXMVG class.

The GXMVG class provides the ability to create view graphs.

__init__(handle=0)[source]

Initialize self. See help(type(self)) for accurate signature.

axis_x(d_y, d_lx, d_rx, d_maj_int, d_min_int, d_size)[source]

Draw an X axis

Parameters

  • d_y (float) – Y location in plot units (mm)

  • d_lx (float) – Left X (rescaling unit)

  • d_rx (float) – Right X (rescaling unit)

  • d_maj_int (float) – Major tick interval (rescaling unit). Ticks drawn in decades in LOG or LOGLINEAR scale

  • d_min_int (float) – Minor tick interval (rescaling unit). Not used in LOG/LOGLINEAR

  • d_size (float) – Tick size in view units (mm) (negative for down ticks)

New in version 5.0.

License: Geosoft End-User License

Note: When Log annotation is applied, nice tick intervals will be calculated

Obsolete

axis_y(d_x, d_by, d_ty, d_maj_int, d_min_int, d_size)[source]

Draw a Y axis

Parameters

  • d_x (float) – X location in plot units (mm)

  • d_by (float) – Bottom Y (rescaling unit)

  • d_ty (float) – Top Y (rescaling unit)

  • d_maj_int (float) – Major tick interval (rescaling unit). Ticks drawn in decades in LOG or LOGLINEAR scale

  • d_min_int (float) – Minor tick interval (rescaling unit). Not used in LOG/LOGLINEAR

  • d_size (float) – Tick size in plot units (mm)(negative for left ticks)

New in version 5.0.

License: Geosoft End-User License

Note: When Log annotation is applied, nice tick intervals will be calculated

Obsolete

classmethod create(map, name, xmin_m, ymin_m, xmax_m, ymax_m, xmin_u, ymin_u, xmax_u, ymax_u)[source]

Create a GXMVG object

Parameters

  • map (GXMAP) – H_MAP handle

  • name (str) – View Name

  • xmin_m (float) – Minimum X in map unit (mm)

  • ymin_m (float) – Minimum Y in map unit (mm)

  • xmax_m (float) – Maximum X in map unit (mm)

  • ymax_m (float) – Maximum Y in map unit (mm)

  • xmin_u (float) – Minimum X in view unit (m for example)

  • ymin_u (float) – Minimum Y in view unit

  • xmax_u (float) – Maximum X in view unit

  • ymax_u (float) – Maximum Y in view unit

Returns

GXMVG handle (NULL if error)

Return type

GXMVG

New in version 5.0.

License: Geosoft End-User License

Note: Obsolete

get_mview()[source]

Get the GXMVIEW Handle of the Object.

Returns

GXMVIEW Handle

Return type

GXMVIEW

New in version 5.0.

License: Geosoft End-User License

Note: Obsolete

grid(d1st_x, d1st_y, d_x, d_y, d_dx, d_dy, l_type)[source]

Draw a grid in the current GXMVG

Parameters

  • d1st_x (float) – X position of 1st vertical grid line to draw (in rescaling unit)

  • d1st_y (float) – Y position of 1st horizontal grid line to draw (in rescaling unit)

  • d_x (float) – X grid increment of rescaled map unit (see above Rescaling functions)

  • d_y (float) – Y grid increment of rescaled map unit (see above Rescaling functions)

  • d_dx (float) – X dot increment/cross X size of rescaled map unit

  • d_dy (float) – Y dot increment/cross Y size of rescaled map unit

  • l_type (int) – MVG_GRID constants

New in version 5.0.

License: Geosoft End-User License

Note: The grid will be drawn in the current window.

In the LOG and LOGLINEAR rescaling modes, grids will be drawn in decades and the X/Y grid increments will be ignored. In addition, grid lines at 0 (zero) and LOGMIN will be drawn.

Obsolete

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

label_x(y, lx, rx, maj_int, just, bound, orient)[source]

Label annotations on the X axis

Parameters

  • y (float) – Y location in plot units (mm)

  • lx (float) – Left X (rescaling unit)

  • rx (float) – Right X (rescaling unit)

  • maj_int (float) – Major tick interval (ignored if in LOG or LOGLINEAR rescaling)

  • just (int) – Label justification MVG_LABEL_JUST constants

  • bound (int) – Edge label bounding MVG_LABEL_BOUND constants

  • orient (int) – Label orientation MVG_LABEL_ORIENT constants

New in version 5.0.

License: Geosoft End-User License

Note: Label bounding will justify edge labels to be inside the bar limits.

When Log annotation is applied, labels will be drawn in decades.

Obsolete

See also

sAxisX_MVG

label_y(x, by, ty, maj_int, just, bound, orient)[source]

Label annotations on the Y axis

Parameters

  • x (float) – X location in plot units (mm)

  • by (float) – Bottom Y (rescaling unit)

  • ty (float) – Top Y (rescaling unit)

  • maj_int (float) – Label interval (ignored if in LOG or LOGLINEAR rescaling)

  • just (int) – Label justification MVG_LABEL_JUST constants

  • bound (int) – Edge label bounding MVG_LABEL_BOUND constants

  • orient (int) – Label orientation MVG_LABEL_ORIENT constants

New in version 5.0.

License: Geosoft End-User License

Note: Label bounding will justify edge labels to be inside the bar limits.

When Log annotation is applied, labels will be drawn in decades.

Obsolete

See also

sAxisY_MVG

classmethod null()[source]

A null (undefined) instance of GXMVG

Returns

A null GXMVG

Return type

GXMVG

poly_line_va(draw, wrap, vv_x, va, vv_array)[source]

Creates PolyLines/polygons from GXVV and GXVA.

Parameters

New in version 5.0.

License: Geosoft End-User License

Note: If the GXVV contains dummies, the polylines will break at the dummies; the polygons will skip the dummies.

If wrapping is applied, POLYGON parameter is ignored and only POLYLINES are drawn.

Obsolete

poly_line_vv(draw, wrap, vv_x, vv_y)[source]

Creates PolyLines/polygons from GXVV and GXVV.

Parameters

New in version 5.0.

License: Geosoft End-User License

Note: If the GXVV contains dummies, the polylines will break at the dummies; the polygons will skip the dummies.

If wrapping is applied, POLYGON parameter is ignored and only POLYLINES are drawn.

Obsolete

rescale_x_range(scale, min, max, log_min)[source]

Re-scale horizontal axis

Parameters

  • scale (int) – MVG_SCALE constants

  • min (float) – Scale information: new minimum X

  • max (float) – Scale information: new maximum X

  • log_min (float) – Scale information: minimum X to apply log10, it is defined only for LOGLINEAR scale

New in version 5.0.

License: Geosoft End-User License

Note: When RescaleX_MVG is used, only the scaling information related to X axis will be considered

Obsolete

rescale_y_range(scale, min, max, log_min)[source]

Re-scale vertical axis

Parameters

  • scale (int) – MVG_SCALE constants

  • min (float) – Scale information: new minimum Y

  • max (float) – Scale information: new maximum Y

  • log_min (float) – Scale information: minimum Y to apply log10, it is defined only for LOGLINEAR scale

New in version 5.0.

License: Geosoft End-User License

Note: When RescaleY_MVG is used, only the scaling information related to Y axis will be considered

Obsolete

MVG_DRAW constants

GXMVG draw define

MVG_DRAW_POLYLINE

Polyline

gxapi.MVG_DRAW_POLYLINE = 0
MVG_DRAW_POLYGON

Polygon

gxapi.MVG_DRAW_POLYGON = 1

MVG_GRID constants

GXMVG grid define

MVG_GRID_DOT

Dot

gxapi.MVG_GRID_DOT = 0
MVG_GRID_LINE

Line

gxapi.MVG_GRID_LINE = 1
MVG_GRID_CROSS

Cross

gxapi.MVG_GRID_CROSS = 2

MVG_LABEL_BOUND constants

GXMVG label bound define

MVG_LABEL_BOUND_NO

No

gxapi.MVG_LABEL_BOUND_NO = 0
MVG_LABEL_BOUND_YES

Yes

gxapi.MVG_LABEL_BOUND_YES = 1

MVG_LABEL_JUST constants

GXMVG label justification define

MVG_LABEL_JUST_TOP

Top

gxapi.MVG_LABEL_JUST_TOP = 0
MVG_LABEL_JUST_BOTTOM

Bottom

gxapi.MVG_LABEL_JUST_BOTTOM = 1
MVG_LABEL_JUST_LEFT

Left

gxapi.MVG_LABEL_JUST_LEFT = 2
MVG_LABEL_JUST_RIGHT

Right

gxapi.MVG_LABEL_JUST_RIGHT = 3

MVG_LABEL_ORIENT constants

GXMVG label orientation

MVG_LABEL_ORIENT_HORIZONTAL

Horizontal

gxapi.MVG_LABEL_ORIENT_HORIZONTAL = 0
MVG_LABEL_ORIENT_TOP_RIGHT

Top right

gxapi.MVG_LABEL_ORIENT_TOP_RIGHT = 1
MVG_LABEL_ORIENT_TOP_LEFT

Top left

gxapi.MVG_LABEL_ORIENT_TOP_LEFT = 2

MVG_SCALE constants

GXMVG scale define

MVG_SCALE_LINEAR

Linear

gxapi.MVG_SCALE_LINEAR = 0
MVG_SCALE_LOG

Log

gxapi.MVG_SCALE_LOG = 1
MVG_SCALE_LOGLINEAR

Loglinear

gxapi.MVG_SCALE_LOGLINEAR = 2

MVG_WRAP constants

GXMVG wrap define

MVG_WRAP_NO

No

gxapi.MVG_WRAP_NO = 0
MVG_WRAP_YES

Yes

gxapi.MVG_WRAP_YES = 1