resqpy.well.WellboreMarker

class resqpy.well.WellboreMarker(parent_model, parent_frame, marker_index, marker_node=None, marker_type=None, interpretation_uuid=None, title=None, originator=None, extra_metadata=None)

Bases: object

Class to handle RESQML WellboreMarker objects.

Note

wellbore markers are not high level RESQML objects

Public Data Attributes:

resqml_type

boundary_feature_dict

Methods:

__init__(parent_model, parent_frame, ...[, ...])

Creates a new wellbore marker object and loads it from xml or populates it from arguments.

create_xml(parent_node[, title])

Creates the xml tree for this wellbore marker.
__init__(parent_model, parent_frame, marker_index, marker_node=None, marker_type=None, interpretation_uuid=None, title=None, originator=None, extra_metadata=None)[source]

Creates a new wellbore marker object and loads it from xml or populates it from arguments.

Parameters

  • parent_model (model.Model object) – the model which the new wellbore marker belongs to

  • parent_frame (wellbore_marker_frame.WellboreMarkerFramer object) – the wellbore marker frame to which the wellbore marker belongs

  • marker_index (int) – index of the wellbore marker in the parent WellboreMarkerFrame object

  • marker_node (xml node, optional) – if given, loads from xml. Else, creates new

  • marker_type (str, optional) – the type of geologic, fluid or contact feature e.g. “fault”, “geobody”, “horizon “, “gas/oil/water down to”, “gas/oil/water up to”, “free water contact”, “gas oil contact”, “gas water contact”, “water oil contact”, “seal”; ignored if marker_node is present

  • interpretation_uuid (uuid.UUID or string, optional) – uuid of the boundary feature interpretation organizational object that the marker refers to; ignored if marker_node is present

  • title (str, optional) – the citation title to use for a new wellbore marker; ignored if marker_node is present

  • originator (str, optional) – the name of the person creating the wellbore marker, defaults to login id; ignored if uuid is not None; ignored if marker_node is present

  • extra_metadata (dict, optional) – string key, value pairs to add as extra metadata for the wellbore marker; ignored if uuid is not None; ignored if marker_node is present

Returns

the newly created wellbore marker object

Note

it is highly recommended that a related boundary feature interpretation uuid is provided

create_xml(parent_node, title='wellbore marker')[source]

Creates the xml tree for this wellbore marker.

Parameters

  • parent_node (xml node) – the root node of the WellboreMarkerFrame object to which the newly created node will be appended

  • title (string, default "wellbore marker") – the citation title of the newly created node; only used if self.title is None

Returns

the newly created xml node