GXEDB class

class geosoft.gxapi.GXEDB
The EDB class provides access to a database as displayed within
Oasis montaj, but does not change data within the database itself.
It performs functions such as setting the current line.

Note:

To obtain access to the database itself, it is recommended practice
to begin with an EDB object, and use the geosoft.gxapi.GXEDB.lock() function to
lock the underlying map to prevent external changes. The returned
DB object (see DB.GXH) may then be safely used to make changes to the map itself.
all_chan_list((GXVV)arg1) → int:
Get a list of the all channels but in the way they are displayed.
Parameters:arg1 (geosoft.gxapi.GXVV) – VV (INT) in which to place the list.
Returns:Number of symbols in the list. Terminates GX if there was an error.
Return type:int

New in version 5.0.0.

Note:

The VV elements must be INT.

Displayed channel lists are filled in the order the channels
appear on the display, left to right.

See also

geosoft.gxapi.GXEDB.disp_chan_list()

apply_formula_internal((str)arg1) → None:
Apply a formula to selected cells of the
current line. (Do not use this wrapper if you
want to apply a formula across multiple lines)

Notes:

The current selection must be on cell(s) of
a channel or on the a channel header.

If the selection is on cell(s) of a channel,
the formula is applied to only these cells.

If the selection is on a channel header, the
formula is applied to every cell in the channel.

The given formula string must be of the form:
"<NameOfCurrentChannel>=<SomeExpression>;"
e.g. "x=y+1;"
Parameters:arg1 (str) – Formula (“<NameOfCurrentChannel>=<SomeExpression>;”)
Returns:Nothing
Return type:None

New in version 5.0.0.

channels() → int:
Returns number of displayed channels
Returns:x - number of displayed channels
Return type:int

New in version 5.0.0.

static current() → GXEDB:
This method returns the Current Edited Database.
Returns:EDB Object
Return type:geosoft.gxapi.GXEDB

New in version 5.0.0.

static current_if_exists() → GXEDB:
This method returns the Current Edited Database.
Returns:EDB Object to current edited database. If there is no current database, the user is not prompted for a database, and 0 is returned.
Return type:geosoft.gxapi.GXEDB

New in version 5.0.0.

static current_no_activate() → GXEDB:
This method returns the Current Edited Database.
Returns:EDB Object
Return type:geosoft.gxapi.GXEDB

New in version 9.0.0.

Note:

This function acts just like geosoft.gxapi.GXEDB.current() except that the document is not activated (brought to foreground) and no
guarantee is given about which document is currently active.
del_line0() → None:
Delete Line 0.
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Deletes an empty line 0 from the database.
destroy_view((int)arg1) → None:
Removes the view from the workspace.
Parameters:arg1 (int) – EDB_REMOVE constants
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Can only be run in interactive mode. After this call the
EDB object will become invalid. If this is the last view on
the document and the document has been modified the map will be
unloaded and optionally saved depending on the EDB_REMOVE constants
parameter.
disp_chan_list((GXVV)arg1) → int:
Get a list of the displayed channel symbols.
Parameters:arg1 (geosoft.gxapi.GXVV) – VV (INT) in which to place the list.
Returns:Number of symbols in the list. Terminates GX if there was an error.
Return type:int

New in version 5.0.0.

Note:

The VV elements must be INT.

Displayed channel lists are filled in the order the channels
appear on the display, left to right.

See also

geosoft.gxapi.GXEDB.disp_chan_lst()

disp_chan_lst((GXLST)arg1) → int:
Get a list of the displayed channel names.
Parameters:arg1 (geosoft.gxapi.GXLST) – LST object
Returns:Number of channels in the list. Terminates GX if there was an error.
Return type:int

New in version 5.0.0.

Note:

Displayed channel lists are filled in the order the channels
appear on the display, left to right.

The channel names will be placed in the "Name" part of
the list and the values are set to the symbol handle.

See also

geosoft.gxapi.GXEDB.disp_chan_list()

disp_class_chan_lst((GXLST)arg1, (str)arg2) → int:
Get a list of the displayed channels in a given channel class.
Parameters:
Returns:

Number of channels in the list. Terminates GX if there was an error.
Return type:

int

New in version 5.0.0.

Note:

Displayed channel lists are filled in the order the channels
appear on the display, left to right.

The channel names will be placed in the "Name" part of
the list and the values are set to the symbol handle.

Examples of channel classes in current use are "MASK" and
"ASSAY". (Searches are case tolerant).

See also

geosoft.gxapi.GXEDB.disp_chan_list()

find_channel_column((str)arg1) → int:
Find the column that contains a channel
Parameters:arg1 (str) – channel
Returns:Column number that contains a specific channel iDUMMY of channel not loaded
Return type:int

New in version 5.0.0.

find_nearest((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (GXIPJ)arg4) → int:
Find the nearest point on the current line based
on X,Y and Z and their projection.
Parameters:
Returns:

x - Nearest point -1 - Not available
Return type:

int

New in version 5.0.0.

get_cur_chan((str_ref)arg1) → None:
Get current channel name.
Parameters:arg1 (geosoft.gxapi.str_ref) – Where to put the name
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

returns "" if mark not currently in a channel.
get_cur_chan_symb() → int:
Returns the currently marked channel symbol.
Returns:Currently channel symbol. NULLSYMB constant if the mark is not in a channel.
Return type:int

New in version 5.0.0.

get_cur_fid() → float:
This method returns the currently selected fiducial if
the user is selecting a fiducial. If not, it returns
a dummy.
Returns:x - Fiducial DUMMY - No Selected Fiducial
Return type:float

New in version 5.0.0.

get_cur_fid_string((str_ref)arg1) → None:
This method returns the currently selected value
at the current fid (if available).
Parameters:arg1 (geosoft.gxapi.str_ref) – String returned here
Returns:Nothing
Return type:None

New in version 5.0.0.

get_cur_line((str_ref)arg1) → None:
Get current line name.
Parameters:arg1 (geosoft.gxapi.str_ref) – Where to put the name
Returns:Nothing
Return type:None

New in version 5.0.0.

get_cur_line_symb() → int:
Get current line symbol.
Returns:Currently displayed line symbol. NULLSYMB constant if no line displayed.
Return type:int

New in version 5.0.0.

get_cur_mark((float_ref)arg1, (float_ref)arg2, (float_ref)arg3) → int:
Returns the current data mark info.
Parameters:
Returns:

0 - if data is marked. 1 - if data is not currently marked.
Return type:

int

New in version 5.0.0.

get_cur_point((float_ref)arg1, (float_ref)arg2, (float_ref)arg3) → None:
Returns the coordinates of the currently selected point in the database (first value if range selected)
Parameters:
Returns:

Nothing
Return type:

None

New in version 9.2.0.

get_current_selection((str_ref)arg1, (str_ref)arg2, (str_ref)arg3, (str_ref)arg4) → None:
Get current selection information.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Channel Name    Empty if no channel
Line Name       "[All]" if all lines are selected
Fid Range       "[All]" if all values in all lines are selected
"[None]"  if no values are selected
"10 to 20"  giving the range of values.
static get_databases_lst((GXLST)arg1, (int)arg2) → int:
Load the file names of open databases into a LST.
Parameters:
Returns:

The number of documents loaded into the LST. The LST is cleared first.
Return type:

int

New in version 5.0.0.

get_displ_fid_range((int_ref)arg1, (int_ref)arg2) → None:
Return the displayed fiducial start index & number of cells
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

get_fid_range((float_ref)arg1, (float_ref)arg2, (int_ref)arg3) → None:
Returns currently displayed fid range
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

get_mark_chan_va((GXVA)arg1, (int)arg2) → int:
Get channel data for the current mark.
Parameters:
  • arg1 (geosoft.gxapi.GXVA) – VA in which to place the data.
  • arg2 (int) – Channel symbol to retrieve.
Returns:

0 if successful. 1 if failed, or if entire database is marked.
Return type:

int

New in version 8.2.0.

Note:

The current "mark" in this case is the start and
end fiducials and not the selected channel. You
can use this method to retrieve the selected range
from any channel, loaded or not.

The VA will be resized to the length of the data
get_mark_chan_vv((GXVV)arg1, (int)arg2) → int:
Get channel data for the current mark.
Parameters:
  • arg1 (geosoft.gxapi.GXVV) – VV in which to place the data.
  • arg2 (int) – Channel symbol to retrieve.
Returns:

0 if successful. 1 if failed, or if entire database is marked.
Return type:

int

New in version 5.0.0.

Note:

The current "mark" in this case is the start and
end fiducials and not the selected channel. You
can use this method to retrieve the selected range
from any channel, loaded or not.

The VV will be resized to the length of the data
get_name((str_ref)arg1) → None:
Get the name of the database object of this EDB.
Parameters:arg1 (geosoft.gxapi.str_ref) – Name returned
Returns:Nothing
Return type:None

New in version 5.0.0.

get_next_line_symb() → int:
Returns the next line symbol.
Returns:The next line symbol of currently displayed line. NULLSYMB constant if no line displayed.
Return type:int

New in version 5.0.0.

get_prev_line_symb() → int:
Returns the previous line symbol.
Returns:The previous line symbol of currently displayed line. NULLSYMB constant if no line displayed.
Return type:int

New in version 5.0.0.

get_profile_parm_double((int)arg1, (int)arg2, (int)arg3) → float:
Get real profile parameter
Parameters:
  • arg1 (int) – profile window number (0 to MAX_PROF_WND-1, see iProfileOpen_EDB)
  • arg2 (int) – profile number in window (see GetProfileRangeY_EDB)
  • arg3 (int) – EDB_PROF constants
Returns:

Real profile parameter
Return type:

float

New in version 5.0.0.

get_profile_parm_int((int)arg1, (int)arg2, (int)arg3) → int:
Get integer profile parameter
Parameters:
  • arg1 (int) – profile window number (0 to MAX_PROF_WND-1, see iProfileOpen_EDB)
  • arg2 (int) – profile number in window (see GetProfileRangeY_EDB)
  • arg3 (int) – EDB_PROF constants
Returns:

Data Value (See notes)
Return type:

int

New in version 5.0.0.

get_profile_range_x((float_ref)arg1, (float_ref)arg2, (int_ref)arg3) → None:
Get profile X range and X channel
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

get_profile_range_y((int)arg1, (int)arg2, (float_ref)arg3, (float_ref)arg4, (int_ref)arg5) → None:
Get profile Y range and display option
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

get_profile_split((float_ref)arg1, (float_ref)arg2) → None:
Get profile split for 3 windows.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

get_profile_split5((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4) → None:
Get profile split for 5 windows.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

get_profile_split_vv((GXVV)arg1) → None:
Get profile window splits.
Parameters:arg1 (geosoft.gxapi.GXVV) – split VV (REAL) (profile window heights / entire profile window height)
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

The returned VV is sized to the maximum number of profiles
that can be displayed. If a profile is not currently displayed,
its height fraction is 0.  The sum of all the fractions returned
is equal to 1.

The profile splits refers to the relative sizes of the individual
profile windows. To get/set the fraction of the total database window
devoted to the profiles, use the geosoft.gxapi.GXEDB.set_split() and geosoft.gxapi.GXEDB.get_split() functions.
get_profile_vertical_grid_lines((int_ref)arg1, (float_ref)arg2) → None:
Get profile grid vertical line info.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

get_profile_window((int)arg1, (int_ref)arg2, (int_ref)arg3) → None:
Get profile window size
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

get_split() → float:
Get split ratio between spreadsheet and profile sections.
Returns:d = (spreadsheet window height/ (spreadsheet window height + entire profile window height))
Return type:float

New in version 5.0.0.

get_window_position((int_ref)arg1, (int_ref)arg2, (int_ref)arg3, (int_ref)arg4, (int_ref)arg5, (int_ref)arg6) → None:
Get the map window's position and dock state
Parameters:
Returns:

Nothing
Return type:

None

New in version 9.0.0.

get_window_state() → int:
Retrieve the current state of the database window
Returns:EDB_WINDOW_STATE constants
Return type:int

New in version 5.0.0.

get_window_y_axis_direction((int)arg1) → int:
Get the y-axis direction for a window
Parameters:arg1 (int) – profile window number (0 to MAX_PROF_WND-1, see iProfileOpen_EDB)
Returns:EDB_YAXIS_DIRECTION constants
Return type:int

New in version 8.3.0.

goto_column((int)arg1) → None:
Move the channel marker to a specific column.
Parameters:arg1 (int) – channel column number, 0 is first -1 for first column without data
Returns:Nothing
Return type:None

New in version 5.0.0.

goto_elem((int)arg1) → None:
Goto an element in the current line.
Parameters:arg1 (int) – Element number
Returns:Nothing
Return type:None

New in version 5.0.0.

goto_line((int)arg1) → None:
Goto to a line symbol in the editor.
Parameters:arg1 (int) – Line symbol to goto to
Returns:Nothing
Return type:None

New in version 5.0.0.

static have_current() → bool:
Returns true if a database is loaded
Returns:bool
Return type:bool

New in version 5.0.0.

histogram((GXST)arg1, (float)arg2, (float)arg3, (int)arg4) → None:
Create histogram stats.
Parameters:
  • arg1 (geosoft.gxapi.GXST) – ST handle to update
  • arg2 (float) – histogram minimum
  • arg3 (float) – histogram increment
  • arg4 (int) – number of increments
Returns:

Nothing
Return type:

None

New in version 5.0.0.

is_locked() → bool:
Is this Database locked
Returns:bool
Return type:bool

New in version 5.0.0.

is_null() → bool

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

Returns:True if this is a null instance of geosoft.gxapi.GXEDB, False otherwise.
Return type:bool`
launch_histogram((str)arg1) → None:
Launch histogram tool on a database.
Parameters:arg1 (str) – First chan name
Returns:Nothing
Return type:None

New in version 5.0.6.

See also

geosoft.gxapi.GXCHIMERA.launch_histogram() in chimera.gxh

launch_scatter() → None:
Launch scatter tool on a database.
Returns:Nothing
Return type:None

New in version 5.0.6.

Note:

The scatter tool uses the following INI parameters

SCATTER.STM       name of the scatter template,"none" for none
SCATTER.STM_NAME  name of last template section, "" for none.
SCATTER.X         name of channel to display in X
SCATTER.Y         name of channel to display in Y
SCATTER.MASK      name of channel to use for mask

See also

geosoft.gxapi.GXCHIMERA.launch_scatter() in chimera.gxh

static load((str)arg1) → GXEDB:
Loads a list of databases into the workspace
Parameters:arg1 (str) – list of databases (‘;’ or ‘|‘ delimited) to load.
Returns:Handle to current edited database, which will be the last database in the list.
Return type:geosoft.gxapi.GXEDB

New in version 5.0.0.

Note:

The last listed database will become the current database.

Databases may already be loaded.

Only the first file in the list may have a directory path.
All other files in the list are assumed to be in the same
directory as the first file.
load_all_chans() → None:
Load all channels into current database
Returns:Nothing
Return type:None

New in version 5.0.0.

load_chan((str)arg1) → None:
Load a channel into current database
Parameters:arg1 (str) – channel name
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

If the channel does not exist, or if channel is already
loaded nothing happens.
static load_control((str)arg1, (HWND)arg2) → None:
Version of geosoft.gxapi.GXEDB.load() that can be used to load a database via subclassing into a Windows control.
Parameters:
  • arg1 (str) – Database filename
  • arg2 (geosoft.gxapi.HWND) – Window handle to receive document
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static load_new((str)arg1) → GXEDB:
Loads a database into the workspace, flags as new.
Parameters:arg1 (str) – Database to load.
Returns:Handle to the current edited database.
Return type:geosoft.gxapi.GXEDB

New in version 5.0.0.

Note:

See geosoft.gxapi.GXEDB.load(). This is used for brand new databases, to set
an internal flag such that if on closing the user chooses
not to save changes, the database is deleted.
static load_new_control((str)arg1, (HWND)arg2) → None:
Version of geosoft.gxapi.GXEDB.load_new() that can be used to load a database via subclassing into a Windows control.
Parameters:
  • arg1 (str) – Database filename
  • arg2 (geosoft.gxapi.HWND) – Window handle to receive document
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static load_no_activate((str)arg1) → GXEDB:
Loads documents into the workspace
Parameters:arg1 (str) – list of documents (‘;’ or ‘|‘ delimited) to load.
Returns:Handle to current edited document, which will be the last database in the list if multiple files were provided.
Return type:geosoft.gxapi.GXEDB

New in version 5.0.0.

Note:

This function acts just like geosoft.gxapi.GXEDB.load() except that the document(s) is not activated (brought to foreground) and no
guarantee is given about which document is currently active.
static load_pass((str)arg1, (str)arg2, (str)arg3) → GXEDB:
Loads a database into the editor with login and password.
Parameters:
  • arg1 (str) – Name of database to load
  • arg2 (str) – Login Name
  • arg3 (str) – Password
Returns:

Handle to current edited database.
Return type:

geosoft.gxapi.GXEDB

New in version 5.0.0.

Note:

The loaded database will become the current database.

If the database is already loaded, it simply becomes
the current database.
static load_pass_control((str)arg1, (str)arg2, (str)arg3, (HWND)arg4) → None:
Version of geosoft.gxapi.GXEDB.load_pass() that can be used to load a database via subclassing into a Windows control.
Parameters:
  • arg1 (str) – Database filename
  • arg2 (str) – Login name
  • arg3 (str) – Password
  • arg4 (geosoft.gxapi.HWND) – Window handle to receive document
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static load_with_view((str)arg1, (GXEDB)arg2) → GXEDB:
Load an EDB with the view from a current EDB.
Parameters:
Returns:

New EDB handle.
Return type:

geosoft.gxapi.GXEDB

New in version 5.0.0.

Note:

Can only be run in interactive mode. Is used by
dbsubset to create a new database with the same
view as previously.
static load_with_view_control((str)arg1, (GXEDB)arg2, (HWND)arg3) → None:
Version of geosoft.gxapi.GXEDB.load_with_view() that can be used to load a database via subclassing into a Windows control.
Parameters:
  • arg1 (str) – Database filename
  • arg2 (geosoft.gxapi.GXEDB) – EDB handle to use as the source view
  • arg3 (geosoft.gxapi.HWND) – Window handle to receive document
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static loaded((str)arg1) → int:
Returns 1 if a database is loaded .
Parameters:arg1 (str) – database name
Returns:1 if database is loaded, 0 otherwise.
Return type:int

New in version 5.0.0.

lock() → GXDB:
This method locks the Edited Database.
Returns:Handle to database associated with edited database.
Return type:geosoft.gxapi.GXDB

New in version 5.0.0.

make_current() → None:
Makes this EDB object the current active object to the user.
Returns:Nothing
Return type:None

New in version 5.0.0.

static null() → GXEDB

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

Returns:A null geosoft.gxapi.GXEDB
Return type:geosoft.gxapi.GXEDB
profile_open((int)arg1) → int:
Return TRUE or FALSE if profile window is open
Parameters:arg1 (int) – profile window number: 0 is the top window 1 is the middle window 2 is the bottom window
Returns:TRUE if window is open FALSE if window is closed
Return type:int

New in version 5.0.0.

Note:

This functions will return FALSE if requested window
is not supported in current version of Oasis montaj.
read_only() → bool:
Checks if a database is currently opened in a read-only mode.
Returns:bool
Return type:bool

New in version 5.0.0.

remove_profile((int)arg1, (int)arg2) → None:
Remove a profile from the profile window
Parameters:
  • arg1 (int) – profile window number (0 to MAX_PROF_WND-1, see iProfileOpen_EDB)
  • arg2 (int) – profile number in window (see GetProfileRangeY_EDB)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

run_channel_maker((str)arg1) → None:
Run the maker for a single channel.
Parameters:arg1 (str) – channel name
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Skips channels without makers; will not return an
error if the channel does not exist.
run_channel_makers() → None:
Recreate channels with makers.
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Skips channels without makers.
set_cur_line((str)arg1) → None:
Set the current line name.
Parameters:arg1 (str) – line name
Returns:Nothing
Return type:None

New in version 5.0.0.

set_cur_line_no_message((str)arg1) → None:
Set Line but do not send a message.
Parameters:arg1 (str) – line name
Returns:Nothing
Return type:None

New in version 5.0.0.

set_cur_mark((float)arg1, (float)arg2) → None:
Set the current mark.
Parameters:
  • arg1 (float) – start fiducial
  • arg2 (float) – end fiducial
Returns:

Nothing
Return type:

None

New in version 5.0.0.

set_profile_parm_i((int)arg1, (int)arg2, (int)arg3, (int)arg4) → None:
Set integer profile parameter
Parameters:
  • arg1 (int) – profile window number (0 to MAX_PROF_WND-1, see iProfileOpen_EDB)
  • arg2 (int) – profile number in window (see GetProfileRangeY_EDB)
  • arg3 (int) – EDB_PROF constants
  • arg4 (int) – setting
Returns:

Nothing
Return type:

None

New in version 5.0.0.

set_profile_parm_r((int)arg1, (int)arg2, (int)arg3, (float)arg4) → None:
Set real profile parameter
Parameters:
  • arg1 (int) – profile window number (0 to MAX_PROF_WND-1, see iProfileOpen_EDB)
  • arg2 (int) – profile number in window (see GetProfileRangeY_EDB)
  • arg3 (int) – EDB_PROF constants
  • arg4 (float) – setting
Returns:

Nothing
Return type:

None

New in version 5.0.0.

set_profile_range_x((float)arg1, (float)arg2, (int)arg3) → None:
Set profile X range and X channel
Parameters:
  • arg1 (float) – minimum x, rDUMMY for data minimum
  • arg2 (float) – maximum x, rDUMMY for data maximum
  • arg3 (int) – X axis channel, NULLSYMB constant to use fids
Returns:

Nothing
Return type:

None

New in version 5.0.0.

set_profile_range_y((int)arg1, (int)arg2, (float)arg3, (float)arg4, (int)arg5) → None:
Set profile Y range and display option
Parameters:
  • arg1 (int) – profile window number (0 to MAX_PROF_WND-1, see iProfileOpen_EDB)
  • arg2 (int) – profile number in window (see GetProfileRangeY_EDB)
  • arg3 (float) – minimum y
  • arg4 (float) – maximum y
  • arg5 (int) – EDB_PROFILE_SCALE constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

If channel is not loaded or displayed, it will
loaded and/or displayed.
set_profile_split((float)arg1, (float)arg2) → None:
Set profile split for 3 windows.
Parameters:
  • arg1 (float) – split d1 (profile window 0 height / entire profile window height)
  • arg2 (float) – split d2 (profile window 1 height / entire profile window height)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

set_profile_split5((float)arg1, (float)arg2, (float)arg3, (float)arg4) → None:
Set profile split for 5 windows.
Parameters:
  • arg1 (float) – split d1 (profile window 0 height / entire profile window height)
  • arg2 (float) – split d2 (profile window 1 height / entire profile window height)
  • arg3 (float) – split d3 (profile window 2 height / entire profile window height)
  • arg4 (float) – split d4 (profile window 3 height / entire profile window height)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

set_profile_split_vv((GXVV)arg1) → None:
Set profile splits
Parameters:arg1 (geosoft.gxapi.GXVV) – split VV (REAL) (relative sizes of each profile window)
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

The input VV values are the fractional heights for each
profile window. Values are summed, and normalized (so you can
enter "1,1,1", with a VV of length 3, if you want 3 equal profile windows).

VV values beyond the maximum number of displayable
profiles (MAX_PROF_WND) are ignored.
set_split((float)arg1) → None:
Set split ratio between spreadsheet and profile sections.
Parameters:arg1 (float) – split d (0.0 <= d <= 1.0).
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

d = (spreadsheet window height/
(spreadsheet window height + entire profile window height))
set_window_position((int)arg1, (int)arg2, (int)arg3, (int)arg4, (int)arg5, (int)arg6) → None:
Get the map window's position and dock state
Parameters:
Returns:

Nothing
Return type:

None

New in version 9.0.0.

set_window_state((int)arg1) → None:
Changes the state of the database window
Parameters:arg1 (int) – EDB_WINDOW_STATE constants
Returns:Nothing
Return type:None

New in version 5.0.0.

show_profile((int)arg1, (int)arg2) → None:
Show a profile in the profile window
Parameters:
  • arg1 (int) – profile window number (0 to MAX_PROF_WND-1, see iProfileOpen_EDB)
  • arg2 (int) – channel symbol
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

If the symbol is not loaded, it will be loaded.
show_profile_name((int)arg1, (str)arg2) → int:
Show a profile in the profile window
Parameters:
  • arg1 (int) – profile window number (0 to MAX_PROF_WND-1, see iProfileOpen_EDB)
  • arg2 (str) – Name of the channel
Returns:

Profile ID if loaded, -1 for error
Return type:

int

New in version 5.0.0.

Note:

If the symbol is not loaded, it will be loaded.
statistics((GXST)arg1) → None:
Add all currently selected data to the ST.
Parameters:arg1 (geosoft.gxapi.GXST) – ST handle to update
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Use geosoft.gxapi.GXEDB.histogram() to get median or histogram.
static un_load((str)arg1) → None:
Unloads an edited database.
Parameters:arg1 (str) – Name of database to unload
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

If the database is not loaded, nothing happens.
Same as geosoft.gxapi.GXEDB.un_load_verify() with FALSE to prompt save.
static un_load_all() → None:
Unloads all opened databases
Returns:Nothing
Return type:None

New in version 5.0.0.

un_load_all_chans() → None:
Unload all channels into current database
Returns:Nothing
Return type:None

New in version 5.0.0.

un_load_chan((str)arg1) → None:
Unload a channel into current database
Parameters:arg1 (str) – channel name
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

If the channel does not exist, or if channel is already
loaded nothing happens.
static un_load_discard((str)arg1) → None:
Unloads a database in the workspace, discards changes.
Parameters:arg1 (str) – Name of database to unload
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

If the database is not loaded, nothing happens.
static un_load_verify((str)arg1, (int)arg2) → None:
Unloads an edited database, optional prompt to save.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

If the database is not loaded, nothing happens.
The user can be prompted to save before unloading.
If EDB_UNLOAD_NO_PROMPT, data is always saved.
EDB_UNLOAD_MULTIPROMPT is now obsolete and
is equivalent to EDB_UNLOAD_SINGLE_PROMPT.
un_lock() → None:
This method unlocks the Edited Database.
Returns:Nothing
Return type:None

New in version 5.0.0.

window_profiles((int)arg1) → int:
Get number of profiles in a window
Parameters:arg1 (int) – profile window number (0 to MAX_PROF_WND-1, see iProfileOpen_EDB)
Returns:Number of profiles in a window
Return type:int

New in version 5.0.0.

MAX_PROF_WND constant

gxapi.MAX_PROF_WND = 5
The following value should be kept synchronized with the value defined in src\geoguilib\stdafx.h

EDB_PATH constants

Four forms
gxapi.EDB_PATH_FULL = 0
d:\directory\file.gdb
gxapi.EDB_PATH_DIR = 1
\directory\file.gdb
gxapi.EDB_PATH_NAME_EXT = 2
file.gdb
gxapi.EDB_PATH_NAME = 3
file

EDB_PROF constants

Profile data
gxapi.EDB_PROF_I_CHANNEL = 0
DB_SYMB
gxapi.EDB_PROF_I_LINE_STYLE = 1
0 - no line
1 - solid
2 - long dash
3 - short dash
gxapi.EDB_PROF_I_LINE_WEIGHT = 2
0 - no line
1 - normal
2 - medium
3 - heavy
gxapi.EDB_PROF_I_SYMBOL = 3
0 - no symbol
1 - rectangle
2 - circle
3 - triangle
4 - diamond
5 - x
6 - +
gxapi.EDB_PROF_I_SYMBOL_WEIGHT = 4
0 - normal
1 - large
gxapi.EDB_PROF_I_COLOR = 5
MVIEW Color Value
gxapi.EDB_PROF_I_WRAP = 6
0-no, 1-yes
gxapi.EDB_PROF_I_BREAK_ON_DUMMY = 7
0-no, 1-yes
gxapi.EDB_PROF_I_GRID_LINE = 8
0-no, 1-yes
gxapi.EDB_PROF_R_GRID_LINE_INTERVAL = 9
0-no, 1-yes
gxapi.EDB_PROF_I_LOG = 10
0-Linear, 1-Log, 2-LogLinear
gxapi.EDB_PROF_R_LOG_MINIMUM = 11
Minimum Value
gxapi.EDB_PROF_I_SAMESCALE = 12
0-no, 1-yes
gxapi.EDB_PROF_I_SOURCELINE = 13
0 - current line
-1 - previous line
-2 - next line
gxapi.EDB_PROF_I_SCALEOPTION = 14
0 - scale to fit for each line
1 - fix the range
2 - fix the scale, center the range
gxapi.EDB_PROF_I_SAMERANGE = 15
0-no, 1-yes

EDB_PROFILE_SCALE constants

Profile Scale Options
gxapi.EDB_PROFILE_SCALE_LINEAR = 0
gxapi.EDB_PROFILE_SCALE_LOG = 1
gxapi.EDB_PROFILE_SCALE_LOGLINEAR = 2

EDB_REMOVE constants

How to handle pending changes in document
gxapi.EDB_REMOVE_SAVE = 0
gxapi.EDB_REMOVE_PROMPT = 1
gxapi.EDB_REMOVE_DISCARD = 2

EDB_UNLOAD constants

What type of prompt
gxapi.EDB_UNLOAD_NO_PROMPT = 0
gxapi.EDB_UNLOAD_SINGLE_PROMPT = 1
gxapi.EDB_UNLOAD_MULTI_PROMPT = 2
Obsolete

EDB_WINDOW_POSITION constants

Window Positioning Options
gxapi.EDB_WINDOW_POSITION_DOCKED = 0
gxapi.EDB_WINDOW_POSITION_FLOATING = 1

EDB_WINDOW_STATE constants

Window State Options
gxapi.EDB_WINDOW_RESTORE = 0
gxapi.EDB_WINDOW_MINIMIZE = 1
gxapi.EDB_WINDOW_MAXIMIZE = 2

EDB_YAXIS_DIRECTION constants

Window State Options
gxapi.EDB_YAXIS_NORMAL = 0
gxapi.EDB_YAXIS_INVERTED = 1