resqpy.organize.FaultInterpretation

class resqpy.organize.FaultInterpretation(parent_model, uuid=None, title=None, tectonic_boundary_feature=None, domain='depth', is_normal=None, is_listric=False, maximum_throw=None, mean_azimuth=None, mean_dip=None, originator=None, extra_metadata=None)

Bases: BaseResqpy

Class for RESQML Fault Interpretation organizational objects.

RESQML documentation:

A type of boundary feature, this class contains the data describing an opinion about the characterization of the fault, which includes the attributes listed below.

Public Data Attributes:

`resqml_type`
`valid_domains`
`feature_uuid`	Returns the UUID of the interpreted feature

Inherited from BaseResqpy

`resqml_type`	Definition of which RESQML object the class represents.
`part`	Standard part name corresponding to self.uuid.
`root`	XML node corresponding to self.uuid.
`citation_title`	Citation block title equivalent to self.title.

Methods:

`__init__`(parent_model[, uuid, title, ...])	Initialises a Fault interpretation organisational object.
`is_equivalent`(other[, check_extra_metadata])	Returns True if this interpretation is essentially the same as the other; otherwise False.
`create_xml`([tectonic_boundary_feature_root, ...])	Creates a fault interpretation organisational xml node from a fault interpretation object.

Inherited from BaseResqpy

`__init__`(model[, uuid, title, originator, ...])	Load an existing resqml object, or create new.
`try_reuse`()	Look for an equivalent existing RESQML object and modify the uuid of this object if found.
`create_xml`([title, originator, ...])	Write citation block to XML.
`append_extra_metadata`(meta_dict)	Append a given dictionary of metadata to the existing metadata.
`__eq__`(other)	Implements equals operator; uses is_equivalent() otherwise compares class type and uuid.
`__ne__`(other)	Implements not equal operator.
`__repr__`()	String representation.

__init__(parent_model, uuid=None, title=None, tectonic_boundary_feature=None, domain='depth', is_normal=None, is_listric=False, maximum_throw=None, mean_azimuth=None, mean_dip=None, originator=None, extra_metadata=None)[source]: Initialises a Fault interpretation organisational object.

append_extra_metadata(meta_dict): Append a given dictionary of metadata to the existing metadata.

property citation_title: Citation block title equivalent to self.title.

create_xml(tectonic_boundary_feature_root=None, add_as_part=True, add_relationships=True, originator=None, title_suffix=None, reuse=True)[source]: Creates a fault interpretation organisational xml node from a fault interpretation object.

property feature_uuid: Returns the UUID of the interpreted feature

is_equivalent(other, check_extra_metadata=True)[source]: Returns True if this interpretation is essentially the same as the other; otherwise False.

property part: Standard part name corresponding to self.uuid.

property root: XML node corresponding to self.uuid.

try_reuse()

Look for an equivalent existing RESQML object and modify the uuid of this object if found.

Returns:: boolean – True if an equivalent object was found, False if not

Note

by design this method may change this object’s uuid as a side effect

title: Citation title

originator: Creator of object. By default, user id.

uuid: Unique identifier