Log

class wellcad.com.Log(dispatch)

The Log class represents a depth or time referenced set of data displayed as a column in a borehole document. Logs can be added/removed/manipulated from the borehole document itself.

>>> import wellcad.com
>>> app = wellcad.com.Application()
>>> borehole = app.new_borehole()
>>> log = borehole.insert_new_log(1) # Create a new well log
allow_export_attribute_dictionary(index, export, password)

When dealing with a protected document you can use this method to enable/disable the option to export the tadpole dictionary (*.TAD) from a specific classification column of a Structure or Breakout Log. This assumes you are in possession of the password.

Parameters

  • index (int) – Zero based index of the classification column for which the protection level should eb changed.

  • export (bool) – Set this boolean to True to allow an export as *.tad file. Set it to False to protect the dictionary.

  • password (str) – the password needed to make changes to the protection level.

allow_export_litho_dictionary(export, password)

When dealing with a protected document you can use this method to enable / disable the option to export the symbol dictionary (*.LTH) of a log. This assumes you are in possession of the password.

Parameters

  • export (bool) – Set this boolean to True to allow the dictionary export. Set it to False to protect the dictionary.

  • password (str) – the password needed to make changes to the protection level.

allow_modify_log_data(export, password)

When dealing with a protected document you can use this method to enable / disable the option to edit the data of a log. This assumes you are in possession of the password.

Parameters

  • export (bool) – Set this boolean to True to allow the modification of log data. Set it to False to protect the data.

  • password (str) – the password needed to make changes to the protection level.

allow_modify_log_settings(export, password)

When dealing with a protected document you can use this method to enable / disable the option to change the settings of a log. This assumes you are in possession of the password.

Parameters

  • export (bool) – Set this boolean to True to allow access to the log settings. Set it to False to protect the log settings.

  • password (str) – the password needed to make changes to the protection level.

allow_use_formula(export, password)

When dealing with a protected document you can use this method to enable / disable the option to access and use the formula in a Formula Log. This assumes you are in possession of the password.

Parameters

  • export (bool) – Set this boolean to True to allow access the formula. Set it to False to protect the formula.

  • password (str) – the password needed to make changes to the protection level.

allow_view_formula(export, password)

When dealing with a protected document you can use this method to enable / disable the option to see the formula used in a Formula Log. This assumes you are in possession of the password.

Parameters

  • export (bool) – Set this boolean to True to see the formula. Set it to False to protect the formula.

  • password (str) – the password needed to make changes to the protection level.

allow_view_log_history(export, password)

When dealing with a protected document you can use this method to enable / disable the option to view the log history. This assumes you are in possession of the password.

Parameters

  • export (bool) – Set this boolean to True to access the log history. Set it to False to protect the log history.

  • password (str) – the password needed to make changes to the protection level.

property aperture_unit

The conversion factor (from meters) for the aperture value in a structure log.

Set it to 0.001 when measured in mm and to 0.00254 when measured in 1/10th inches.

Type

float

attach_attribute_dictionary(attribute, file)

Attaches a new attribute library (*.TAD file) to a Breakout, Lineation or Structure Log.

Parameters

  • attribute (str) – Name of the classification column.

  • file (str) – Path to the TAD file to attach.

Raises

pywintypes.com_error – If the classification column doesn’t exist, an exception is raised.

attach_litho_dictionary(dictionary)

Attaches a new symbol or pattern library (*.LTH file) to Litho, CoreDesc, Strata, Analysis or Percentage Log.

Parameters

dictionary (str) – path and name of the LTH file to attach

Returns

The LithoDictionary object

Return type

LithoDictionary

property background_color

The background color of the engineering log.

Colours are specified as a 32 bit integer with an xBGR structure. Each of the blue (B), green (G) and red (R) components are 8 bit values.

Type

int

property background_hatch_style

The background hatch style for the Engineering Log.

Available styles are:

  • 0: horizontal

  • 1: vertical

  • 2: forward diagonal

  • 3: backward diagonal

  • 4: cross

  • 5: diagonal cross

If an invalid style is set, nothing will happen.

Type

int

property background_style

The background style for the Engineering Log.

Available styles are:

  • 0: none

  • 1: solid

  • 2: hatch

If an invalid style is set, nothing will happen.

Type

int

property border_color

The border color of the log column.

Colours are specified as a 32 bit integer with an xBGR structure. Each of the blue (B), green (G) and red (R) components are 8 bit values. Other allowed values are : 0xFFFFFFFF (None) and 0xFF000000 (automatic color).

Type

int

property border_style

The border line style of the log column.

Styles are specified as an integer:

  • Solid = 0

  • Dashed = 1

  • Dotted = 2

  • Dash-Dot = 3

  • Dash-dot-dot = 4

Type

int

property border_width

The width for the log column border in 1/10 mm.

Type

float

property bottom_depth

The depth of the of the bottom-most (deepest) data point in the log using the current depth reference units.

Type

float

breakout(index)

Gets a breakout structure from the Breakout Log at the specified index.

Parameters

index (int) – Zero based index of the breakout to be retrieved.

Returns

The breakout at the specified index. If the index is outside the valid range no exception will be raised and None will be returned.

Return type

Structure or None

breakout_at_depth(depth)

Gets a breakout structure from the Breakout Log at the specified depth in current depth units.

Parameters

depth (float) – The depth value in current depth units at which the breakout will be retrieved.

Returns

The feature closest to the specified depth will be returned. If the depth is outside the valid range no exception will be raised and None will be returned.

Return type

Structure or None

property caliper_unit

The conversion factor (from meters) for the caliper value in a structure log.

Set it to 0.001 when measured in mm and to 0.0254 when measured in inches.

Type

float

clear_history()

Removes all entries from the log history.

comment_box(index)

Gets the Comment Box object from the Comment Log at the specified index.

Parameters

index (int) – Zero based index at which the box will be retrieved.

Returns

The CommentBox at the desired index or None if index is out of range.

Return type

CommentBox or None

comment_box_at_depth(depth)

Gets the Comment Box object from the Comment Log at the specified depth.

Parameters

depth (float) – The depth value in current depth units at which the comment box will be retrieved.

Returns

The CommentBox at the desired depth or None if depth is out of range.

Return type

CommentBox or None

property comment_style

The position of the comment associated with an engineering log.

The following styles are available:

  • 0 = None, comment is not displayed

  • 1 = Left, comment displayed on the left of the engineering log

  • 2 = Right, comment displayed on the right of the engineering log

Type

int

cross_box(index)

Gets a Cross Box object from the Cross Section Log at the specified index.

Parameters

index (int) – Zero based index of the box to be retrieved.

Returns

The CrossSectionBox at the desired index or None if index is out of range.

Return type

CrossSectionBox or None

cross_box_at_depth(depth)

Gets a Cross Box object from the Cross Section Log at the specified depth in current depth units.

Parameters

depth (float) – The depth of the box to be retrieved in current depth units.

Returns

The CrossSectionBox at the desired index or None if the index is out of range.

Return type

CrossSectionBox or None

data_depth(index)

Gets the log data depth for the specified index.

This method can be called for Mud, Well, Depth, Percent, Analysis, FWS, Image and RGB Logs. For logs with a constant sample step (Well, Image, RGB, Analysis Logs), the index 0 corresponds to the Bottom Depth.

Parameters

index (int) – Zero based index of the data to be retrieved.

Returns

The depth of the log data at the specified index. If the index is out of bounds, this will be 0.0 for a Mud Log, and an extrapolated value for a Well Log.

Return type

float

property data_max

The maximum data value of the Well, Mud or Interval Log.

Type

float

property data_min

The minimum data value of the Well, Mud or Interval Log.

Type

float

property data_table

The data table for a log. The first row in the data table is reserved for the log titles (e.g. for a Well Log the fist row in the data table contains the column titles “Depth” and the actual log title). The data format for each log equals the data displayed in the Tabular Editor.

Type

tuple of tuples

property diameter_high

The maximum diameter scaling value (width of the log column) for an Engineering Log.

Type

float

property display_border

Whether the log column border is displayed.

Type

bool

drill_item(index)

Gets a Drill Item object from the Engineering Log at the specified index.

Parameters

index (int) – Zero based index at which the drill item will be retrieved.

Returns

The drill item at the specified index.

Return type

DrillItem

drill_item_at_depth(depth)

Gets a Drill Item object from the Engineering Log at the specified depth.

Parameters

depth (float) – The depth of the item to be retrieved in current depth units.

Returns

The drill item at the specified depth.

Return type

DrillItem

eqp_item(index)

Gets an Equipment Item object at the specified index from the Engineering Log.

Parameters

index (int) – Zero based index at which the item will be retrieved.

Returns

The equipment item at the specified index.

Return type

EquipmentItem

file_export(directory, file_title=None, extension=None, prompt_user=None, config_filename=None)

Exports the data of the log in the specified format (TXT, CSV, ASC, WA* for all log types, BMP, TIF, GIF, JPG, PNG in addition for RGB and Image Logs).

Parameters

  • directory (str) – Path to the location where the file should be stored.

  • file_title (str, optional) – Name of the file that will be created. By default the log title will be taken.

  • extension (str, optional) – The file extension to be used.

  • prompt_user (bool, optional) – If set to True any warning messages during the graphic file export will be shown.

  • config_filename (str, optional) – Configuration file used for ASCII (TXT, CSV, ASC, WA*) export only.

Returns

Whether the log was successfully exported.

Return type

bool

property filter

The width (in samples) of the display filter used for Well Logs.

Type

int

property fixed_bar_width

The fixed bar width, in units of 1/10 mm, for Mud Logs.

Type

int

property font

Gets the font used in a Comment Log as Font Object.

property formula

The mathematical formula used for a Formula log.

Raises

pywintypes.com_error – If, during setting, the supplied formula is invalid.

Type

str

fossil_item(index)

Gets a Fossil Item object from the CoreDesc Log at the specified index.

Items are ordered by ascending top depth.

Parameters

index (int) – Zero based index of the item to be retrieved.

Returns

The FossilItem at the desired index or none if index is out of range.

Return type

FossilItem or None

fossil_item_at_depth(depth)

Gets a fossil item object from the CoreDesc Log at the specified depth.

Parameters

depth (float) – depth value in current depth units at which the item will be retrieved

Returns

The FossilItem at the desired depth or None if depth is out of range.

Return type

FossilItem or None

get_attribute_name(index)

Gets the name of the attribute class (i.e. classification column) in a Breakout, Lineation or Structure Log.

Parameters

index (str) – Zero based index of the column.

Returns

The name of the attribute class (classification column)

Return type

str

Raises

pywintypes.com_error – If the column index points to a non existent column (out of index range) an exception will be raised.

get_column_name(column)

Gets set the name of a Strata Log column.

Parameters

column (int) – Zero based index of the column to be retrieved

Returns

The name of the column.

Return type

str

get_component_name(column)

Gets the name (i.e. litho code) for the component used in the specified data column of a Percentage or Analysis Log.

Parameters

column (int) – Zero based index of the data column in the tabular editor for which the component name should be set or retrieved.

Returns

The code of the component used in the specified data column of a Percentage or Analysis Log.

Return type

str

get_data(index)

Gets the data value for the specified index.

This method is only applicable for a Well, Mud, Interval or Depth Log.

Parameters

index (int) – Zero based index of the data to be retrieved.

Returns

The value of the log data at the specified index.

Return type

float

get_data_at_depth(depth)

Gets the log data value at the specified depth.

This method is only applicable for a Well, Mud, Interval or Depth Log.

Parameters

depth (float) – Depth value in current master depth units.

Returns

The value of the log data at the specified depth.

Return type

float

get_litho_bed(index)

Gets a LithoBed object at the specified index from a Lithology Log.

Items are ordered by ascending top depth.

Parameters

index (int) – Zero based index of the LithoBed to retrieve.

Returns

The LithoBed at the desired index.

Return type

LithoBed

get_litho_bed_at_depth(depth)

Gets a LithoBed object at the specified depth from a Lithology Log.

Parameters

depth (float) – Depth value in current depth units at which the item will be retrieved.

Returns

The LithoBed at the desired depth.

Return type

LithoBed

get_trace_data(depth_index, trace_index)

Gets the data value at the specified row index and position within the trace (column index) of an Analysis, Percentage, FWS, Image or RGB Log.

Parameters

  • depth_index (int) – zero based index of the depth (0 = bottom depth for FWS, Image, RGB and Analysis logs, top depth for Percent logs).

  • trace_index (int) – zero based index of the column.

Returns

The data value at the specified index and column. The current No-Data value (e.g. -999) will be returned if the depth or trace index refers to a non-existent (out of index range) data point.

Return type

float

get_trace_data_at_depth(depth, trace_position)

Gets the data value at the specified depth and position within the trace of an Analysis, Percentage, FWS, Image or RGB Log.

Parameters

  • depth (float) – The depth value at which you would like to retrieve the data value in the current depth units.

  • trace_position (float) – The position within the trace (time or angle as shown in the column header of the tabular editor, not the index) at which you would like to retrieve the data value.

Returns

The data value at the specified depth and column. The current No-Data value (e.g. -999) will be returned if the depth or trace index refers to a non-existent (out of index range) data point.

Return type

float

property ground_depth

The starting point (reference datum) of the borehole.

Type

float

property hide_log_data

Whether the log data is hidden.

Type

bool

property hide_log_title

Whether the log title is hidden.

Type

bool

history_item_date(index)

Gets the date of the history item at the specified index.

Parameters

index (int) – Zero based index of the history entry.

Returns

The timezone-aware datetime of the history item.

Return type

pywintypes.datetime

history_item_description(index)

Gets the description of the history item at the specified index.

Parameters

index (int) – Zero based index of the history entry.

Returns

The description of the specified history entry.

Return type

str

insert_data(index, value)

Inserts a new data value at the specified index.

If necessary existing data points will be shifted.

Parameters

  • index (int) – Zero based index at which the new data point will be inserted. The index must be lower or equal to the number of data points in the log.

  • value (float) – The new data value.

Raises

pywintypes.com_error – If the data couldn’t be inserted (out-of-bounds index or other)

insert_data_at_depth(depth, value)

Inserts a new data value at the specified depth.

Data points above (shallower depth) will be shifted upward to accomodate the newly inserted point in a Well Log.

Parameters

  • depth (float) – Depth in current master units at which the new data point should be inserted. Depth is rounded to the nearest sample for Well Logs.

  • value (float) – The new data value

insert_new_attribute(attribute_name)

Inserts a new blank classification column to a Breakout, Lineation or Structure Log.

Parameters

attribute_name (str) – Name of the new class.

insert_new_breakout_ex(depth, azimuth, tilt, length, opening)

Sets a new breakout structure in a Breakout Log.

If the mirror option is active, a second breakout structure object is added 180° degrees apart.

Parameters

  • depth (float) – The depth value of the breakout structure in current depth units.

  • azimuth (float) – The azimuth angle of the breakout structure measured in degrees.

  • tilt (float) – The tilt angle of the breakout structure measured in degrees.

  • length (float) – The length of the breakout structure in meters.

  • opening (float) – The opening (or aperture) angle of the breakout structure in degrees.

Returns

The newly created breakout structure.

Return type

Structure

insert_new_comment_box(top_depth, bottom_depth, text)

Sets a new box with the specified text into a Comment Log.

Parameters

  • top_depth (float) – The top of the box in current depth units.

  • bottom_depth (float) – The bottom of the box in current depth units.

  • text (str) – The text to be displayed in the new box.

Returns

The newly created CommentBox.

Return type

CommentBox

insert_new_cross_box(top_depth, bottom_depth)

Inserts a new box into the Cross Section Log.

Parameters

  • top_depth (float) – The top depth value of the cross section box in current depth units.

  • bottom_depth (float) – The bottom depth value of the cross section box in current depth units.

Returns

The newly created CrossSectionBox.

Return type

CrossSectionBox

insert_new_drill_item(bottom_depth, diameter)

Inserts a new drill item into the Engineering Log.

Item index are ordered by depth value in the stack of drill items.

Parameters

  • bottom_depth (float) – The bottom depth of the borehole in current depth units. (The top depth is either the ground_depth or the former bottom depth).

  • diameter (float) – The diameter of the borehole.

Returns

The inserted DrillItem

Return type

DrillItem

insert_new_eqp_item(top_depth, bottom_depth, name)

Inserts a new equipment item of the specified name and depth interval into the Engineering Log.

The new item is given the last index in the list of equipment items.

Parameters

  • top_depth (float) – The top depth of the equipment item interval in current units.

  • bottom_depth (float) – The bottom depth of the equipment item interval in current units.

  • name (str) –

    The name (code) of the equipment item to be inserted. Base available equipments names are listed below, but you can modify or add your own in the Equipment dictionary.

    • PlainCasing

    • WireWoundCasing

    • SlottedCasing

    • PerforatedCasing

    • Centralizer

    • Shoe

    • Packer

    • Water

    • Wedge

    • HeadWorks

    • Transducer

    • Gauge

    • Cement

    • Gravel

    • NormalThread

    • ReverseThread

    • Plug

    If an invalid name is provided, no item will be inserted.

Returns

The inserted EqpItem

Return type

EqpItem

insert_new_fossil_item(top_depth, bottom_depth, litho_code, abundance, dominance, position)

Inserts a new data point or interval into a Core Description Log.

Parameters

  • top_depth (float) – Top depth of the new data interval in current depth units.

  • bottom_depth (float) – Bottom depth of the new data interval in current depth units.

  • litho_code (str) – Code of the symbol representing the feature as defined in the symbol library of the log.

  • abundance (int) – The abundance value associated with the symbol (e.g. between 0 and 9).

  • dominance (int) – The dominance value associated with the symbol undiff = 0 minor = 1 major = 2

  • position (float) – A value between 0 and 1 determining the horizontal position of the symbol within the log column.

Returns

The newly created FossilItem.

Return type

FossilItem

insert_new_interval_item(top_depth, bottom_depth, value)

Inserts a new interval in an Interval log.

Parameters

  • top_depth (float) – The top depth of the new interval in current depth units.

  • bottom_depth (float) – The bottom depth of the new interval in current depth units.

  • value (float) – The value of the new interval item.

Returns

The newly inserted interval item.

Return type

IntervalItem

insert_new_lineation_ex(depth, trend, plunge, eccentricity)

Sets a new linear structure in a Lineation Log.

Parameters

  • depth (float) – Depth of the mid-point of the fitted line in current depth units.

  • trend (float) – Trend direction of the vector in degrees.

  • plunge (float) – “Dip” angle of the vector in degrees.

  • eccentricity (float) – Offset of the lineation from the center of the borehole. A value between -1 and 1 can be set. An eccentricity of 0 corresponds to a line going straight through the center of the borehole.

Returns

The newly created lineation structure.

Return type

Structure

insert_new_litho_bed(top_depth, bottom_depth, litho_code, value, position)

Inserts a new lithology bed into a Litho Log.

Parameters

  • top_depth (float) – Top depth of the new data interval in current depth units.

  • bottom_depth (float) – Bottom depth of the new data interval in current depth units.

  • litho_code (str) – Code of the symbol representing the feature as defined in the symbol library of the log.

  • value (float) – Hardness value between 0 and 1.

  • position (float) – A value between 0 and 1 determining the horizontal position of a non repeated symbol in percent of the track width.

Returns

The newly created LithoBed.

Return type

LithoBed

insert_new_marker(depth, name, comment, contact)

Inserts a new marker at the specified depth into a Marker Log

Parameters

  • depth (float) – The depth value in current depth units at which the marker will be added.

  • name (str) – The name (or identifier) of the marker.

  • comment (str) – The optional comment for the marker.

  • contact (str) – Name of a contact style to be used and available in the contact dictionary of the Marker Log.

Returns

The Marker object at the desired depth with the specified attributes.

Return type

MarkerItem

insert_new_ole_box_from_file(file_name, allow_picture, top_depth, bottom_depth)

Inserts a new OLE object between the specified interval into an OLE Log.

OLE objects can be files such as images, Excel charts, Word documents or pdfs.

Parameters

  • file_name (str) – Path and name of the file to be loaded.

  • allow_picture (bool) – Set to True to allow graphic files to be displayed using an internal viewer.

  • top_depth (float) – Top depth of the OLE object in current depth units.

  • bottom_depth (float) – Bottom depth of the OLE object in current depth units.

insert_new_schmit_box(top_depth, bottom_depth, text)

Inserts a new box into a Polar & Rose Log.

Parameters

  • top_depth (float) – The top depth value of the interval in the current depth units.

  • bottom_depth (float) – The bottom depth value of the interval in the current depth units.

  • text (string) – A text description which is only shown in the tabular editor display.

Returns

The newly created Polar & Rose box.

Return type

PolarAndRoseBox

insert_new_stack_item(top_depth, bottom_depth, top_width, bottom_width)

Inserts a new data interval into a Stacking Pattern Log.

Parameters

  • top_depth (float) – The top depth value of the interval in the current depth units.

  • bottom_depth (float) – The bottom depth value of the interval in the current depth units.

  • top_width (float) – Width value at the top of the new interval.

  • bottom_width (float) – Width value at the bottom of the new interval.

Returns

The newly created StackingPatternItem.

Return type

StackingPatternItem

insert_new_structure_ex(depth, azimuth, dip, aperture)

Sets a new structure in a Structure Log.

Parameters

  • depth (float) – The depth value in the current units of the breakout structure to be inserted.

  • azimuth (float) – The azimuth angle of the structure measured in degrees.

  • dip (float) – The tilt angle of the structure measured in degrees.

  • aperture (float) – The aperture of the structure in meters.

Returns

The newly created structure object.

Return type

Structure

insert_trace(index)

Inserts a new data trace into an Image, FWS or Analysis Log at the specified index.

Columns for the newly inserted trace are filled with No-Data value. Edit them with set_trace_data or set_trace_data_at_depth.

Parameters

index (int) – Zero based index at which the trace should be added. Index zero represents the deepest trace. The maximum allowed index is (number of traces + 1). For Image and Analysis logs, existing traces will be shifted upwards depth wise.

insert_trace_at_depth(depth)

Inserts a new data trace into an Image, FWS or Analysis or Percent Log at the specified depth.

Columns for the newly inserted trace are filled with No-Data value. Edit them with set_trace_data or set_trace_data_at_depth.

Parameters

depth (float) – The depth value in current depth units at which the new data trace will be inserted. For Image and Analysis logs: Insertion depth is rounded to the nearest sample. Value must be within the depth range of the existing traces or contiguous to that range (± 1.5 * sampling rate). If necessary existing traces will be shifted upwards. For Percent and FWS logs, if there is already data at that depth, it is replaced with No-Data value, otherwise a trace is inserted at the desired depth without shifting other traces depth wise.

interval_item(index)

Gets an interval item object from an Interval Log.

Items are ordered by ascending top depth.

Parameters

index (int) – Zero based index of the interval item.

Returns

The interval item at the specified index, or None if the index is out of range.

Return type

IntervalItem or None

interval_item_at_depth(depth)

Gets an interval item object from an Interval Log at the specified depth.

Parameters

depth (float) – Depth value of the interval item, in current master depth units.

Returns

The interval item at the specified depth, or None if no interval item exists at the specified depth.

Return type

IntervalItem or None

property left_position

The position of the left side of the log column as a fraction of the document width.

In the case that this is set to be a value higher than right_position, the two attributes will swap. Values will be clamped in the range [0.0, 1.0].

Type

float

property length_unit

The conversion factor (from meters) for the breakout structure length measured in the breakout log

Set it to 0.001 when measured in mm and to 0.0254 when measured in inches.

Type

float

lineation(index)

Gets a lineation pick from the Lineation Log at the specified index.

Parameters

index (int) – Zero based index of the lineation to be retrieved.

Returns

The lineation at the specified index. If the index is outside the valid range no exception will be raised and None will be returned.

Return type

Structure or None

lineation_at_depth(depth)

Gets a lineation structure from the Lineation Log at the specified depth in current depth units.

Parameters

depth (float) – The depth value in current depth units at which the lineation will be retrieved.

Returns

The feature closest to the specified depth will be returned. If the depth is outside the valid range no exception will be raised and None will be returned.

Return type

Structure or None

property litho_dictionary

The symbol library used by the log as LithoDictionary object.

Type

LithoDictionary

property lock_log_data

Whether the log data is protected from editing.

Type

bool

property log_background_color

The background color of the log column.

Colours are specified as a 32 bit integer with an xBGR structure. Each of the blue (B), green (G) and red (R) components are 8 bit values. Other allowed values are : 0xFFFFFFFF (None) and 0xFF000000 (automatic color).

Type

int

property log_unit

The unit of a log. Restricted to log types having a unit in the log title.

Type

str

property maj_grid_enable

Whether to display major vertical gridlines.

Type

bool

property maj_grid_spacing

The spacing between major vertical gridlines.

Type

float

marker(index)

Gets the marker with the specified index.

Parameters

index (int) – Zero based index of the marker.

Returns

The marker with the specified index.

Return type

MarkerItem

marker_by_name(name)

Gets the marker with the specified name.

Parameters

name (str) – Name of the marker to be retrieved.

Returns

The marker with the specified name.

Return type

MarkerItem

property mask_contacts

Whether contact lines within the log column are masked or not.

Type

bool

property mask_horizontal_grid

Whether the horizontal (depth) gridlines of a log are masked or not.

Type

bool

property min_grid_enable

Whether to display minor vertical gridlines.

Type

bool

property min_grid_spacing

The spacing between minor vertical gridlines.

Type

float

property name

The title of the log.

Type

str

property nb_of_data

The number of data points in a log.

Type

int

property nb_of_drill_item

The number of drill items in an Engineering Log.

Type

int

property nb_of_eqp_item

The number of equipment items in an Engineering Log.

Type

int

property nb_of_history_item

The number of entries in the history (audit trail) of a log.

Type

int

property null_value

The value that is treated as Null (not displayed) in a log.

Type

float

property pen_color

The pen color for a Well or Mud log.

Colours are specified as a 32 bit integer with an xBGR structure. Each of the blue (B), green (G) and red (R) components are 8 bit values. Other allowed values are : 0xFFFFFFFF (None) and 0xFF000000 (automatic color).

Type

int

property pen_style

The pen style for the Well or Mud log.

Styles are specified as an integer:

  • Solid = 0

  • Dashed = 1

  • Dotted = 2

  • Dash-Dot = 3

  • Dash-dot-dot = 4

Type

int

property pen_width

The pen width used in a Well or Mud Log in units of 1/10 mm.

Type

int

remove_breakout(index)

Removes a breakout structure from the Breakout Log at the specified index.

Parameters

index (int) – Zero based index of the breakout structure to be removed.

remove_breakout_at_depth(depth)

Removes a breakout structure from the Breakout Log at the specified depth in current depth units.

Parameters

depth (float) – The depth value in current depth units at which the breakout structure will be removed.

remove_comment_box(index)

Removes a comment box from the Comment log at the specified index.

Parameters

index (int) – Zero based index at which the comment box will be removed.

remove_comment_box_at_depth(depth)

Removes a comment box from the Comment log at the specified depth.

Parameters

depth (float) – The depth value in current depth units at which the comment box will be removed.

remove_cross_box(index)

Removes a box from the Cross Section Log at the specified index.

Parameters

index (int) – Zero based index of the box to be removed.

remove_cross_box_at_depth(depth)

Removes a box from the Cross Section Log at the specified depth.

Parameters

depth (float) – The depth in current units at which the box will be removed.

remove_data(index)

Removes a data point from a Mud or Well Log.

For Well Logs the data value will be set to Null.

Parameters

index (int) – Zero based index for the data point to be removed

remove_data_at_depth(depth)

Removes a data point from a Mud or Well Log.

All data points above (shallower depth) the removed point will be shifted downward (deeper) when data is removed from a Well Log.

Parameters

depth (float) – The depth value (in current master units) at which the data point. will be removed.

remove_drill_item(index)

Removes the drill item at the specified index from an Engineering Log.

Parameters

index (int) – Zero based index at which the item will be removed.

remove_eqp_item(index)

Removes an equipment item at the specified depth index from an Engineering Log.

Parameters

index (int) – Zero based index at which the item will be removed.

remove_fossil_item(index)

Removes an item at the specified index from a CoreDesc Log.

Parameters

index (int) – Zero based index of the fossil item to be removed.

remove_fossil_item_at_depth(depth)

Removes an item at the specified index from a CoreDesc Log.

Parameters

depth (float) – the depth value of the symbol in current depth units at which it will be removed.

remove_interval_item(index)

Removes a data interval from an Interval log.

Parameters

index (int) – Zero based index to specify which data interval will be removed.

remove_interval_item_at_depth(depth)

Removes a data interval from an Interval log.

Parameters

depth (float) – Depth value in current master units to specify which interval item will be removed.

remove_lineation(index)

Removes a lineation from the Lineation Log at the specified index.

Parameters

index (int) – Zero based index of the lineation to be removed.

remove_lineation_at_depth(depth)

Removes a lineation from the Lineation Log at the specified depth in current depth units.

Parameters

depth (float) – The depth value in current depth units at which the lineation will be removed.

remove_litho_bed(index)

Removes a lithology bed from the Lithology log at the specified index.

Parameters

index (int) – Zero based index of the lithology bed item to be removed.

remove_litho_bed_at_depth(depth)

Removes a lithology bed from the Lithology log at the specified depth.

Parameters

depth (float) – the depth value in current depth units at which the lithological bed will be removed.

remove_marker(index)

Removes the marker from a Marker Log at the specified index.

Parameters

index (int) – Zero based index at which the marker box will be removed.

remove_schmit_box(index)

Removes a box from the Polar & Rose Log at the specified index.

Parameters

index (int) – Zero based index of the Polar & Rose box to be removed.

remove_schmit_box_at_depth(depth)

Removes a box from the Polar & Rose log at the specified depth in current depth units.

Parameters

depth (float) – The depth of the Polar & Rose box to be removed in current depth units.

remove_stack_item(index)

Removes an item from the Stacking Pattern Log at the specified index.

Parameters

index (int) – Zero based index of the stacking pattern box to be removed.

remove_stack_item_at_depth(depth)

Removes an item from the Stacking Pattern Log at the specified depth.

Parameters

depth (float) – The depth of the stack item to be removed in current depth units.

remove_strata_column(index)

Removes the the specified column from a Strata Log at the specified index.

Parameters

index (int) – Zero based index of the column to be removed.

remove_structure(index)

Removes a structure from the Structure Log at the specified index.

Parameters

index (int) – Zero based index of the structure to be removed.

remove_structure_at_depth(depth)

Removes a structure from the Structure Log at the specified depth in current depth units.

Parameters

depth (float) – The depth value in current depth units at which the structure will be removed.

remove_trace(index)

Remove an entire data trace from an Image, FWS, Analysis or Percentage Log.

For Image logs, if the trace is the first or the last, it is removed. Otherwise, it sets all values of that trace to No-Data value. For Analysis, it is the same as for Image logs, but the replacement value is 0. For FWS logs, it removes the trace and shifts down all above traces.

Parameters

index (int) – Zero based index of the trace (0 = bottom depth).

remove_trace_at_depth(depth)

Remove an entire data trace from an Image, FWS, Analysis or Percentage Log.

For Image logs, if the trace is the first or the last, it is removed. Otherwise, it sets all values of that trace to No-Data value. For Analysis, it is the same as for Image logs, but the replacement value is 0. For FWS logs and Percent, it removes the trace and shifts down all above traces.

Parameters

depth (float) – The depth value in current depth units at which the trace will be removed or set to No-Data value.

property right_position

The position of the right side of the log column as a fraction of the document width.

In the case that this is set to be a value lower than left_position, the two attributes will swap. Values will be clamped in the range [0.0, 1.0].

Type

float

property sample_rate

The sample interval of a log in current master depth units.

Type

float

property scale_high

The high value of the log scale.

Type

float

property scale_low

The low value of the log scale.

Type

float

property scale_mode

The horizontal scale mode (linear or logarithmic) of a log.

This property is only available for Well or Mud logs, and can have the following values:

  • Linear = 0

  • Logarithmic = 1

Type

int

property scale_reversed

Whether the data display scale is reversed.

Type

bool

schmit_box(index)

Gets a box object from the Polar & Rose Log at the specified index.

Parameters

index (int) – Zero based index of the box to be returned.

Returns

The Polar & Rose box at the desired index.

Return type

PolarAndRoseBox

schmit_box_at_depth(depth)

Gets a box object from the Polar & Rose Log at the specified depth in current depth units.

Parameters

depth (float) – The depth of the box to be returned in current depth units.

Returns

The Polar & Rose box at the desired depth.

Return type

PolarAndRoseBox

set_attribute_name(index, name)

Sets the name of the attribute class (i.e. classification column) in a Breakout, Lineation or Structure Log.

Parameters

  • index (str) – Zero based index of the column.

  • name (str) – New name of the classification column.

Raises

pywintypes.com_error – If the column index points to a non existent column (out of index range) an exception will be raised.

set_column_name(column, name)

Sets set the name of a Strata Log column.

Parameters

  • column (int) – Zero based index of the column to be retrieved

  • name (str) – New name of the column.

set_component_name(column, code)

Sets the name (i.e. litho code) for the component used in the specified data column of a Percentage or Analysis Log.

Parameters

  • column (int) – Zero based index of the data column in the tabular editor for which the component name should be set or retrieved.

  • code (str) – Code of the component to be used in the specified data column of a Percentage or Analysis Log.

set_data(index, value)

Sets the data value for the specified index.

This method is only applicable for a Well, Mud, Interval or Depth Log.

Parameters

  • index (int) – Zero based index of the data to be retrieved.

  • value (float) – The value you want to set the data to.

set_data_at_depth(depth, value)

Sets the log data value at the specified depth.

This method is only applicable for a Well, Mud, Interval or Depth Log.

Parameters

  • depth (float) – Depth value in current master depth units.

  • value (float) – The value you want to set the data to.

set_litho_bed(index, litho_bed)

Sets a LithoBed object at the specified index from another LithoBed object.

Parameters

  • index (int) – Zero based index of the LithoBed to retrieve.

  • litho_bed (LithoBed) – The LithoBed object to copy.

set_litho_bed_at_depth(depth, litho_bed)

Sets a LithoBed object at the specified depth from another LithoBed object.

Parameters

  • depth (float) – Depth value in current depth units at which the item will be retrieved.

  • litho_bed (LithoBed) – The LithoBed object to copy.

set_position(left, right)

Sets the position and width of the log.

Values given outside the range of [0.0, 1.0] will be clamped. If left > right, the arguments are swapped.

Parameters

  • left (float) – The position of the left side of the log column as a fraction of the document width.

  • right (float) – The position of the right side of the log column as a fraction of the document width.

set_trace_data(depth_index, trace_index, value)

Sets the data value at the specified row index and position within the trace (column index) of an Analysis, Percentage, FWS, Image or RGB Log.

Parameters

  • depth_index (int) – zero based index of the depth (0 = bottom depth).

  • trace_index (int) – zero based index of the column.

  • value (float) – The value you want to set the data to.

set_trace_data_at_depth(depth, trace_position, value)

set the data value at the specified depth and position within the trace of an Analysis, Percentage, FWS, Image or RGB Log

Parameters

  • depth (float) – The depth value at which you would like to retrieve the data value in the current depth units.

  • trace_position (float) – The position within the trace (time or angle as shown in the column header of the tabular editor, not the index) at which you would like to retrieve the data value.

  • value (float) – The value you want to set the data to.

property shading

The shading position used in a Well or Mud Log.

  • None = 0

  • Left = 1

  • Right = 2

  • Full = 3

Type

int

stack_item(index)

Gets a Stack Item object from the Stacking Pattern Log at the specified depth index.

Items are ordered by ascending top depth.

Parameters

index (int) – Zero based index of the item to be retrieved.

Returns

The StackingPatternItem at the desired index or None if the index is out of range.

Return type

StackingPatternItem or None

stack_item_at_depth(depth)

Gets a Stack Item object from the Stacking Pattern Log at the specified depth in current depth units.

Parameters

depth (float) – The depth of the item to be retrieved in current depth units.

Returns

The StackingPatternItem at the desired depth or None if depth is out of range.

Return type

StackingPatternItem or None

strata_column(index)

Gets a column from a Strata Log as Comment Log object.

Parameters

index (int) – Zero based index of the column to be returned.

Returns

A comment log object.

Return type

Log

structure(index)

Gets a Structure object from the Structure Log at the specified index.

Parameters

index (int) – Zero based index of the structure object to be retrieved.

Returns

The structure at the specified index. If the index is outside the valid range no exception will be raised and None will be returned.

Return type

Structure or None

structure_at_depth(depth)

Gets the closest Structure object from the Structure Log to the specified depth in current depth units.

Parameters

depth (float) – The depth value in current depth units at which the structure object will be retrieved.

Returns

The feature closest to the specified depth will be returned. If the depth is outside the valid range no exception will be raised and None will be returned.

Return type

Structure or None

property style

The data display style for a log.

For Mud logs:

  • Fixed Bar = 1

  • Dynamic Bar = 2

  • Line = 3

For Engineering logs:

  • Full = 0

  • Left = 1

  • Right = 2

Type

int

property title_comment

The title comment for this log.

Type

str

property top_depth

The depth of the first top-most (shallowest) data point in the log using the current depth reference units.

Type

float

property trace_length

The length of a data trace in Image, RGB and FWS Logs.

For FWS, Analysis and Percent logs: If trace_length is set to a lower value than the current one, all the trace columns past the desired length are discared. If trace_length is set to a higher value than the current one, additional columns are filled with No-data values. For Image and RGB logs: If trace_length is set to a lower value than the current one, trace value are resampled and averaged. If trace_length is set to a higher value than the current one, TODO determine behaviour here.

Type

int

property trace_offset

The offset of a data trace in the FWS Log.

Type

float

property trace_sample_rate

The trace sample interval for a FWS Logs.

Type

float

property type

The log type index.

Log types are one of the below:

  • Undefined = 0

  • Well log = 1

  • Formula log = 2

  • Mud log = 3

  • FWS log = 4

  • Image log = 5

  • Structure log = 6

  • Litho log = 7

  • Comment log = 8

  • Engineering log = 9

  • RGB log = 10

  • Image Float 2 log = 11

  • Image float 4 log = 12

  • Interval log = 13

  • Analysis log = 14

  • Percentage log = 15

  • Coredesc log = 16

  • Depth log = 17

  • Strata log = 18

  • Stack log = 19

  • Polar & Rose log = 20

  • Cross log = 21

  • OLE log = 22

  • Shading log = 23

  • Marker log = 24

  • Breakout log = 25

  • Bio log = 26

  • Lineation log = 27

Type

int

property use_log_colored_background

Whether the background color of a log is displayed.

Type

bool

property used_as_depth_scale

Whether the Depth Log is used as the current depth reference axis.

Type

bool