GXEDB class¶
-
class
GXEDB
(handle=0)¶ GXEDB class.
The
GXEDB
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
GXEDB
object, and use thelock
function to lock the underlying map to prevent external changes. The returnedGXDB
object (seeGXDB
) may then be safely used to make changes to the map itself.-
all_chan_list
(vv)¶ Get a list of the all channels but in the way they are displayed.
Parameters: vv (GXVV) – GXVV
(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.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: The
GXVV
elements must be INT.Displayed channel lists are filled in the order the channels appear on the display, left to right.
See also
-
apply_formula_internal
(formula)¶ 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: formula (str) – Formula (“<NameOfCurrentChannel>=<SomeExpression>;”) New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
channels
()¶ Returns number of displayed channels
Returns: x - number of displayed channels Return type: int New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
classmethod
current
()¶ This method returns the Current Edited Database.
Returns: GXEDB
ObjectReturn type: GXEDB New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
classmethod
current_if_exists
()¶ This method returns the Current Edited Database.
Returns: GXEDB
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: GXEDB New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
classmethod
current_no_activate
()¶ This method returns the Current Edited Database.
Returns: GXEDB
ObjectReturn type: GXEDB New in version 9.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: This function acts just like
current
except that the document is not activated (brought to foreground) and no guarantee is given about which document is currently active.
-
del_line0
()¶ Delete Line 0.
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: Deletes an empty line 0 from the database.
-
destroy_view
(unload_flag)¶ Removes the view from the workspace.
Parameters: unload_flag (int) – EDB_REMOVE constants New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: Can only be run in interactive mode. After this call the
GXEDB
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
(vv)¶ Get a list of the displayed channel symbols.
Parameters: vv (GXVV) – GXVV
(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.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: The
GXVV
elements must be INT.Displayed channel lists are filled in the order the channels appear on the display, left to right.
See also
-
disp_chan_lst
(lst)¶ Get a list of the displayed channel names.
Parameters: lst (GXLST) – GXLST
objectReturns: Number of channels in the list. Terminates GX if there was an error. Return type: int New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
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
-
disp_class_chan_lst
(lst, class_name)¶ 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.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
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
-
find_channel_column
(chan)¶ Find the column that contains a channel
Parameters: chan (str) – Channel Returns: Column number that contains a specific channel iDUMMY
of channel not loadedReturn type: int New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
find_nearest
(x, y, z, ipj)¶ 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.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_cur_chan
(str_val)¶ Get current channel name.
Parameters: str_val (str_ref) – Where to put the name New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: Returns “” if mark not currently in a channel.
-
get_cur_chan_symb
()¶ Returns the currently marked channel symbol.
Returns: Currently channel symbol. NULLSYMB
if the mark is not in a channel.Return type: int New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_cur_fid
()¶ 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.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_cur_fid_string
(val)¶ This method returns the currently selected value at the current fid (if available).
Parameters: val (str_ref) – String returned here New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_cur_line
(str_val)¶ Get current line name.
Parameters: str_val (str_ref) – Where to put the name New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_cur_line_symb
()¶ Get current line symbol.
Returns: Currently displayed line symbol. NULLSYMB
if no line displayed.Return type: int New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_cur_mark
(start, end, inc)¶ 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.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_cur_point
(x, y, z)¶ Returns the coordinates of the currently selected point in the database (first value if range selected)
Parameters: New in version 9.2.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_current_selection
(db, chan, line, fid)¶ Get current selection information.
Parameters: New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
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.
-
classmethod
get_databases_lst
(lst, path)¶ Load the file names of open databases into a
GXLST
.Parameters: - lst (GXLST) –
GXLST
to load - path (int) – EDB_PATH constants
Returns: The number of documents loaded into the
GXLST
. TheGXLST
is cleared first.Return type: int
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
- lst (GXLST) –
-
get_displ_fid_range
(start, num)¶ Return the displayed fiducial start index & number of cells
Parameters: New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_fid_range
(start, incr, num)¶ Returns currently displayed fid range
Parameters: New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_mark_chan_va
(vv, chan)¶ Get channel data for the current mark.
Parameters: Returns: 0 if successful. 1 if failed, or if entire database is marked.
Return type: int
New in version 8.2.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
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
GXVA
will be resized to the length of the data
-
get_mark_chan_vv
(vv, chan)¶ Get channel data for the current mark.
Parameters: Returns: 0 if successful. 1 if failed, or if entire database is marked.
Return type: int
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
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
GXVV
will be resized to the length of the data
-
get_name
(name)¶ Get the name of the database object of this
GXEDB
.Parameters: name (str_ref) – Name returned New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_next_line_symb
()¶ Returns the next line symbol.
Returns: The next line symbol of currently displayed line. NULLSYMB
if no line displayed.Return type: int New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_prev_line_symb
()¶ Returns the previous line symbol.
Returns: The previous line symbol of currently displayed line. NULLSYMB
if no line displayed.Return type: int New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_profile_parm_double
(window, prof, parm)¶ Get real profile parameter
Parameters: - window (int) – Profile window number (0 to
MAX_PROF_WND
-1, seeprofile_open
) - prof (int) – Profile number in window (see
get_profile_range_y
) - parm (int) – EDB_PROF constants
Returns: Real profile parameter
Return type: float
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
- window (int) – Profile window number (0 to
-
get_profile_parm_int
(window, prof, parm)¶ Get integer profile parameter
Parameters: - window (int) – Profile window number (0 to
MAX_PROF_WND
-1, seeprofile_open
) - prof (int) – Profile number in window (see
get_profile_range_y
) - parm (int) – EDB_PROF constants
Returns: Data Value (See notes)
Return type: int
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
- window (int) – Profile window number (0 to
-
get_profile_range_x
(min_x, max_x, ph_chan_x)¶ Get profile X range and X channel
Parameters: New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_profile_range_y
(window, prof, min_y, max_y, scl)¶ Get profile Y range and display option
Parameters: - window (int) – Profile window number (0 to
MAX_PROF_WND
-1, seeprofile_open
) - prof (int) – Profile number in window (see
window_profiles
which returns number of profiles in a window) - min_y (float_ref) – Minimum y
- max_y (float_ref) – Maximum y
- scl (int_ref) – EDB_PROFILE_SCALE constants
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
- window (int) – Profile window number (0 to
-
get_profile_split
(d1, d2)¶ Get profile split for 3 windows.
Parameters: New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_profile_split5
(d1, d2, d3, d4)¶ Get profile split for 5 windows.
Parameters: - d1 (float_ref) – Split d1 (profile window 0 height / entire profile window height)
- d2 (float_ref) – Split d2 (profile window 1 height / entire profile window height)
- d3 (float_ref) – Split d3 (profile window 2 height / entire profile window height)
- d4 (float_ref) – Split d4 (profile window 3 height / entire profile window height)
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_profile_split_vv
(vv)¶ Get profile window splits.
Parameters: vv (GXVV) – Split GXVV
(REAL) (profile window heights / entire profile window height)New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: The returned
GXVV
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
set_split
andget_split
functions.
-
get_profile_vertical_grid_lines
(grid, interval)¶ Get profile grid vertical line info.
Parameters: New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_profile_window
(window, x, y)¶ Get profile window size
Parameters: - window (int) – Profile window number (0 to
MAX_PROF_WND
-1, seeprofile_open
) - x (int_ref) – Window x size in pixels
- y (int_ref) – Window y size in pixels
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
- window (int) – Profile window number (0 to
-
get_split
()¶ 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.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_window_position
(left, top, right, bottom, state, is_floating)¶ Get the map window’s position and dock state
Parameters: - left (int_ref) – Window left position
- top (int_ref) – Window top position
- right (int_ref) – Window right position
- bottom (int_ref) – Window bottom position
- state (int_ref) – Window state EDB_WINDOW_STATE constants
- is_floating (int_ref) – Docked or floating EDB_WINDOW_POSITION constants
New in version 9.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_window_state
()¶ Retrieve the current state of the database window
Returns: EDB_WINDOW_STATE constants Return type: int New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
get_window_y_axis_direction
(window)¶ Get the y-axis direction for a window
Parameters: window (int) – Profile window number (0 to MAX_PROF_WND
-1, seeprofile_open
)Returns: EDB_YAXIS_DIRECTION constants Return type: int New in version 8.3.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
goto_column
(col)¶ Move the channel marker to a specific column.
Parameters: col (int) – Channel column number, 0 is first -1 for first column without data New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
goto_elem
(elem)¶ Goto an element in the current line.
Parameters: elem (int) – Element number New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
goto_line
(line_symb)¶ Goto to a line symbol in the editor.
Parameters: line_symb (int) – Line symbol to goto to New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
classmethod
have_current
()¶ Checks if any database is currently loaded
Return type: bool New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
histogram
(st, min, incr, count)¶ Create histogram stats.
Parameters: New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
is_locked
()¶ Checks if the database locked
Return type: bool New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
is_null
()¶ Check if this is a null (undefined) instance
Returns: True if this is a null (undefined) instance, False otherwise. Return type: bool
-
launch_histogram
(chan)¶ Launch histogram tool on a database.
Parameters: chan (str) – First chan name New in version 5.0.6.
License: Geosoft Open License
See also
GXCHIMERA.launch_histogram
in chimera.gxh
-
launch_scatter
()¶ Launch scatter tool on a database.
New in version 5.0.6.
License: Geosoft Open License
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
GXCHIMERA.launch_scatter
in chimera.gxh
-
classmethod
load
(name)¶ Loads a list of databases into the workspace
Parameters: name (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: GXEDB New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
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
()¶ Load all channels into current database
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
load_chan
(chan)¶ Load a channel into current database
Parameters: chan (str) – Channel name New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: If the channel does not exist, or if channel is already loaded nothing happens.
-
classmethod
load_control
(db_file, window)¶ Version of
load
that can be used to load a database via subclassing into a Windows control.Parameters: - db_file (str) – Database filename
- window (int) – Window handle to receive document
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
classmethod
load_new
(name)¶ Loads a database into the workspace, flags as new.
Parameters: name (str) – Database to load. Returns: Handle to the current edited database. Return type: GXEDB New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: See
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.
-
classmethod
load_new_control
(db_file, window)¶ Version of
load_new
that can be used to load a database via subclassing into a Windows control.Parameters: - db_file (str) – Database filename
- window (int) – Window handle to receive document
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
classmethod
load_no_activate
(name)¶ Loads documents into the workspace
Parameters: name (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: GXEDB New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: This function acts just like
load
except that the document(s) is not activated (brought to foreground) and no guarantee is given about which document is currently active.
-
classmethod
load_pass
(name, login, password)¶ Loads a database into the editor with login and password.
Parameters: - name (str) – Name of database to load
- login (str) – Login Name
- password (str) – Password
Returns: Handle to current edited database.
Return type: New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: The loaded database will become the current database.
If the database is already loaded, it simply becomes the current database.
-
classmethod
load_pass_control
(db_file, user, password, window)¶ Version of
load_pass
that can be used to load a database via subclassing into a Windows control.Parameters: - db_file (str) – Database filename
- user (str) – Login name
- password (str) – Password
- window (int) – Window handle to receive document
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
classmethod
load_with_view
(name, p2)¶ Load an
GXEDB
with the view from a currentGXEDB
.Parameters: Returns: New
GXEDB
handle.Return type: New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: Can only be run in interactive mode. Is used by dbsubset to create a new database with the same view as previously.
-
classmethod
load_with_view_control
(db_file, edb, window)¶ Version of
load_with_view
that can be used to load a database via subclassing into a Windows control.Parameters: New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
classmethod
loaded
(name)¶ Checks if a specific database is loaded.
Parameters: name (str) – Database name Return type: bool New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
lock
()¶ This method locks the Edited Database.
Returns: Handle to database associated with edited database. Return type: GXDB New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
make_current
()¶ Makes this
GXEDB
object the current active object to the user.New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
profile_open
(window)¶ Return TRUE or FALSE if profile window is open
Parameters: window (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.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: This functions will return FALSE if requested window is not supported in current version of Oasis montaj.
-
read_only
()¶ Checks if a database is currently opened in a read-only mode.
Return type: bool New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
remove_profile
(window, prof)¶ Remove a profile from the profile window
Parameters: - window (int) – Profile window number (0 to
MAX_PROF_WND
-1, seeprofile_open
) - prof (int) – Profile number in window (see
get_profile_range_y
)
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
- window (int) – Profile window number (0 to
-
run_channel_maker
(chan)¶ Run the maker for a single channel.
Parameters: chan (str) – Channel name New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: Skips channels without makers; will not return an error if the channel does not exist.
-
run_channel_makers
()¶ Recreate channels with makers.
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: Skips channels without makers.
-
set_cur_line
(line)¶ Set the current line name.
Parameters: line (str) – Line name New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
set_cur_line_no_message
(str_val)¶ Set Line but do not send a message.
Parameters: str_val (str) – Line name New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
set_cur_mark
(start, end)¶ Set the current mark.
Parameters: - start (float) – Start fiducial
- end (float) – End fiducial
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
set_profile_parm_i
(window, prof, parm, value)¶ Set integer profile parameter
Parameters: - window (int) – Profile window number (0 to
MAX_PROF_WND
-1, seeprofile_open
) - prof (int) – Profile number in window (see
get_profile_range_y
) - parm (int) – EDB_PROF constants
- value (int) – Setting
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
- window (int) – Profile window number (0 to
-
set_profile_parm_r
(window, prof, parm, value)¶ Set real profile parameter
Parameters: - window (int) – Profile window number (0 to
MAX_PROF_WND
-1, seeprofile_open
) - prof (int) – Profile number in window (see
get_profile_range_y
) - parm (int) – EDB_PROF constants
- value (float) – Setting
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
- window (int) – Profile window number (0 to
-
set_profile_range_x
(min_x, max_x, x_ch)¶ Set profile X range and X channel
Parameters: New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
set_profile_range_y
(min_x, max_x, min_y, max_y, scl)¶ Set profile Y range and display option
Parameters: - min_x (int) – Profile window number (0 to
MAX_PROF_WND
-1, seeprofile_open
) - max_x (int) – Profile number in window (see
get_profile_range_y
) - min_y (float) – Minimum y
- max_y (float) – Maximum y
- scl (int) – EDB_PROFILE_SCALE constants
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: If channel is not loaded or displayed, it will loaded and/or displayed.
- min_x (int) – Profile window number (0 to
-
set_profile_split
(d1, d2)¶ Set profile split for 3 windows.
Parameters: - d1 (float) – Split d1 (profile window 0 height / entire profile window height)
- d2 (float) – Split d2 (profile window 1 height / entire profile window height)
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
set_profile_split5
(d1, d2, d3, d4)¶ Set profile split for 5 windows.
Parameters: - d1 (float) – Split d1 (profile window 0 height / entire profile window height)
- d2 (float) – Split d2 (profile window 1 height / entire profile window height)
- d3 (float) – Split d3 (profile window 2 height / entire profile window height)
- d4 (float) – Split d4 (profile window 3 height / entire profile window height)
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
set_profile_split_vv
(vv)¶ Set profile splits
Parameters: vv (GXVV) – Split GXVV
(REAL) (relative sizes of each profile window)New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: The input
GXVV
values are the fractional heights for each profile window. Values are summed, and normalized (so you can enter “1,1,1”, with aGXVV
of length 3, if you want 3 equal profile windows).GXVV
values beyond the maximum number of displayable profiles (MAX_PROF_WND
) are ignored.
-
set_split
(d)¶ Set split ratio between spreadsheet and profile sections.
Parameters: d (float) – Split d (0.0 <= d <= 1.0). New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: d = (spreadsheet window height/ (spreadsheet window height + entire profile window height))
-
set_window_position
(left, top, right, bottom, state, is_floating)¶ Get the map window’s position and dock state
Parameters: - left (int) – Window left position
- top (int) – Window top position
- right (int) – Window right position
- bottom (int) – Window bottom position
- state (int) – Window state EDB_WINDOW_STATE constants
- is_floating (int) – Docked or floating EDB_WINDOW_POSITION constants
New in version 9.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
set_window_state
(state)¶ Changes the state of the database window
Parameters: state (int) – EDB_WINDOW_STATE constants New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
show_profile
(window, symb)¶ Show a profile in the profile window
Parameters: - window (int) – Profile window number (0 to
MAX_PROF_WND
-1, seeprofile_open
) - symb (int) – Channel symbol
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: If the symbol is not loaded, it will be loaded.
- window (int) – Profile window number (0 to
-
show_profile_name
(state, chan)¶ Show a profile in the profile window
Parameters: - state (int) – Profile window number (0 to
MAX_PROF_WND
-1, seeprofile_open
) - chan (str) – Name of the channel
Returns: Profile ID if loaded, -1 for error
Return type: int
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: If the symbol is not loaded, it will be loaded.
- state (int) – Profile window number (0 to
-
statistics
(st)¶ Add all currently selected data to the
GXST
.Parameters: st (GXST) – GXST
handle to updateNew in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: Use
histogram
to get median or histogram.
-
classmethod
un_load
(name)¶ Unloads an edited database.
Parameters: name (str) – Name of database to unload New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: If the database is not loaded, nothing happens. Same as
un_load_verify
with FALSE to prompt save.
-
classmethod
un_load_all
()¶ Unloads all opened databases
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
un_load_all_chans
()¶ Unload all channels into current database
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
un_load_chan
(chan)¶ Unload a channel into current database
Parameters: chan (str) – Channel name New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: If the channel does not exist, or if channel is already loaded nothing happens.
-
classmethod
un_load_discard
(name)¶ Unloads a database in the workspace, discards changes.
Parameters: name (str) – Name of database to unload New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
Note: If the database is not loaded, nothing happens.
-
classmethod
un_load_verify
(name, prompt)¶ Unloads an edited database, optional prompt to save.
Parameters: - name (str) – Name of database to unload
- prompt (int) – EDB_UNLOAD constants
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
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 toEDB_UNLOAD_SINGLE_PROMPT
.
-
un_lock
()¶ This method unlocks the Edited Database.
New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
window_profiles
(window)¶ Get number of profiles in a window
Parameters: window (int) – Profile window number (0 to MAX_PROF_WND
-1, seeprofile_open
)Returns: Number of profiles in a window Return type: int New in version 5.0.
License: Geosoft Open License
Limitations: May not be available while executing a command line program.
-
MAX_PROF_WND constants¶
The following value should be kept synchronized with the value defined in src\geoguilib\stdafx.h
-
MAX_PROF_WND
¶ Max prof wnd
-
gxapi.
MAX_PROF_WND
= 5
-
EDB_PATH constants¶
Four forms
-
EDB_PATH_FULL
¶ d:\directory\file.gdb
-
gxapi.
EDB_PATH_FULL
= 0
-
-
EDB_PATH_DIR
¶ \directory\file.gdb
-
gxapi.
EDB_PATH_DIR
= 1
-
-
EDB_PATH_NAME_EXT
¶ File.gdb
-
gxapi.
EDB_PATH_NAME_EXT
= 2
-
-
EDB_PATH_NAME
¶ File
-
gxapi.
EDB_PATH_NAME
= 3
-
EDB_PROF constants¶
Profile data
-
EDB_PROF_I_CHANNEL
¶ DB_SYMB
-
gxapi.
EDB_PROF_I_CHANNEL
= 0
-
-
EDB_PROF_I_LINE_STYLE
¶ 0 - no line 1 - solid 2 - long dash 3 - short dash
-
gxapi.
EDB_PROF_I_LINE_STYLE
= 1
-
-
EDB_PROF_I_LINE_WEIGHT
¶ 0 - no line 1 - normal 2 - medium 3 - heavy
-
gxapi.
EDB_PROF_I_LINE_WEIGHT
= 2
-
-
EDB_PROF_I_SYMBOL
¶ 0 - no symbol 1 - rectangle 2 - circle 3 - triangle 4 - diamond 5 - x 6 - +
-
gxapi.
EDB_PROF_I_SYMBOL
= 3
-
-
EDB_PROF_I_SYMBOL_WEIGHT
¶ 0 - normal 1 - large
-
gxapi.
EDB_PROF_I_SYMBOL_WEIGHT
= 4
-
-
EDB_PROF_I_WRAP
¶ 0-no, 1-yes
-
gxapi.
EDB_PROF_I_WRAP
= 6
-
-
EDB_PROF_I_BREAK_ON_DUMMY
¶ 0-no, 1-yes
-
gxapi.
EDB_PROF_I_BREAK_ON_DUMMY
= 7
-
-
EDB_PROF_I_GRID_LINE
¶ 0-no, 1-yes
-
gxapi.
EDB_PROF_I_GRID_LINE
= 8
-
-
EDB_PROF_R_GRID_LINE_INTERVAL
¶ 0-no, 1-yes
-
gxapi.
EDB_PROF_R_GRID_LINE_INTERVAL
= 9
-
-
EDB_PROF_I_LOG
¶ 0-Linear, 1-Log, 2-LogLinear
-
gxapi.
EDB_PROF_I_LOG
= 10
-
-
EDB_PROF_R_LOG_MINIMUM
¶ Minimum Value
-
gxapi.
EDB_PROF_R_LOG_MINIMUM
= 11
-
-
EDB_PROF_I_SAMESCALE
¶ 0-no, 1-yes
-
gxapi.
EDB_PROF_I_SAMESCALE
= 12
-
-
EDB_PROF_I_SOURCELINE
¶ 0 - current line -1 - previous line -2 - next line
-
gxapi.
EDB_PROF_I_SOURCELINE
= 13
-
-
EDB_PROF_I_SCALEOPTION
¶ 0 - scale to fit for each line 1 - fix the range 2 - fix the scale, center the range
-
gxapi.
EDB_PROF_I_SCALEOPTION
= 14
-
-
EDB_PROF_I_SAMERANGE
¶ 0-no, 1-yes
-
gxapi.
EDB_PROF_I_SAMERANGE
= 15
-
EDB_PROFILE_SCALE constants¶
Profile Scale Options
-
EDB_PROFILE_SCALE_LINEAR
¶ Linear
-
gxapi.
EDB_PROFILE_SCALE_LINEAR
= 0
-
-
EDB_PROFILE_SCALE_LOG
¶ Log
-
gxapi.
EDB_PROFILE_SCALE_LOG
= 1
-
-
EDB_PROFILE_SCALE_LOGLINEAR
¶ Loglinear
-
gxapi.
EDB_PROFILE_SCALE_LOGLINEAR
= 2
-
EDB_REMOVE constants¶
How to handle pending changes in document
-
EDB_REMOVE_SAVE
¶ Save
-
gxapi.
EDB_REMOVE_SAVE
= 0
-
-
EDB_REMOVE_PROMPT
¶ Prompt
-
gxapi.
EDB_REMOVE_PROMPT
= 1
-
-
EDB_REMOVE_DISCARD
¶ Discard
-
gxapi.
EDB_REMOVE_DISCARD
= 2
-
EDB_UNLOAD constants¶
What type of prompt
-
EDB_UNLOAD_NO_PROMPT
¶ No prompt
-
gxapi.
EDB_UNLOAD_NO_PROMPT
= 0
-
-
EDB_UNLOAD_SINGLE_PROMPT
¶ Single prompt
-
gxapi.
EDB_UNLOAD_SINGLE_PROMPT
= 1
-
-
EDB_UNLOAD_MULTI_PROMPT
¶ Obsolete
-
gxapi.
EDB_UNLOAD_MULTI_PROMPT
= 2
-
EDB_WINDOW_POSITION constants¶
Window Positioning Options
-
EDB_WINDOW_POSITION_DOCKED
¶ Docked
-
gxapi.
EDB_WINDOW_POSITION_DOCKED
= 0
-
-
EDB_WINDOW_POSITION_FLOATING
¶ Floating
-
gxapi.
EDB_WINDOW_POSITION_FLOATING
= 1
-