LoopStructural.visualisation.model_plotter.StructuralFrame

class LoopStructural.visualisation.model_plotter.StructuralFrame(name: str, features: list, fold=None)

Bases: BaseFeature

Structural frame is a curvilinear coordinate system defined by structural observations associated with a fault or fold.

Parameters:

• frame (name - name of the structural) –

• with (features - list of features to build the frame) –

__init__(name: str, features: list, fold=None)

Structural frame is a curvilinear coordinate system defined by structural observations associated with a fault or fold.

Parameters:

• frame (name - name of the structural) –

• with (features - list of features to build the frame) –

Methods

__init__(name, features[, fold])	Structural frame is a curvilinear coordinate system defined by structural observations associated with a fault or fold.
add_region(region)	Adds a region where the geological feature is active to the model.
evaluate_gradient(evaluation_points[, i])	Evaluate the gradient of the structural frame.
evaluate_normalised_value(pos)	Evaluate the feature value scaling between 0 and 1
evaluate_value(evaluation_points)	Evaluate the value of the structural frame for the points.
get_feature(i)	Return the ith feature
max()	Calculate the maximum value of the geological feature in the model
min()	Calculate the min value of the geological feature in the model
set_model(model)	Link the model that created the frame to the frame and the features that make up the frame
to_json()	Return a json representation of the structural frame
toggle_faults()	Turn the fault off for a feature This function is only really used for debugging or creating methods explanation figures

Attributes

faults
model

add_region(region)

Adds a region where the geological feature is active to the model.

Parameters:

region (boolean function(x,y,z)) – returns true if inside region, false if outside can be passed as a lambda function e.g. lambda pos : feature.evaluate_value(pos) > 0

evaluate_gradient(evaluation_points, i=None)

Evaluate the gradient of the structural frame. Can optionally only evaluate the ith coordinate

Parameters:

• evaluation_points –

• i –

evaluate_normalised_value(pos: Number | List[Number])

Evaluate the feature value scaling between 0 and 1

Parameters:

pos (NumericInput) – An array or arraylike object with locations

evaluate_value(evaluation_points)

Evaluate the value of the structural frame for the points. Can optionally only evaluate one coordinate

Parameters:

• evaluation_points –

• i –

get_feature(i)

Return the ith feature

Parameters:

i –

max()

Calculate the maximum value of the geological feature in the model

Returns:

maximum, float – max value of the feature evaluated on a regular grid in the model domain

min()

Calculate the min value of the geological feature in the model

Returns:

minimum, float – min value of the feature evaluated on a regular grid in the model domain

set_model(model)

Link the model that created the frame to the frame and the features that make up the frame

Parameters:

model (GeologicalModel) – the geological model that created the fold frame

to_json()

Return a json representation of the structural frame

Returns:

json (dict) – json representation of the structural frame

toggle_faults()

Turn the fault off for a feature This function is only really used for debugging or creating methods explanation figures