LoopStructural.visualisation.Loop2DView#
- class LoopStructural.visualisation.Loop2DView(model=None, bounding_box=array([[0., 0.], [0., 0.]]), nsteps=None, ax=None, **kwargs)#
Bases:
object
- Parameters:
left (origin - lower)
right (maximum - upper)
cells (nsteps - number of)
kwargs
- __init__(model=None, bounding_box=array([[0., 0.], [0., 0.]]), nsteps=None, ax=None, **kwargs)#
- Parameters:
left (origin - lower)
right (maximum - upper)
cells (nsteps - number of)
kwargs
Methods
__init__
([model, bounding_box, nsteps, ax])add_contour
(feature, values[, z, mask])Add an isoline of a scalar field to the map
add_data
(feature[, val, grad, unfault, dip])Adds the data associated to the feature to the plot :param feature: the feature whose data you want to add :type feature: GeologicalFeature :param val: whether to add value data :type val: bool :param grad: whether to add gradient data :type grad: bool :param unfault: plot points in their restored location :type unfault: bool :param dip: whether to annotate the dip, default False :type dip: bool :param kwargs are passed to matplotlib functions and draw strike:
add_fault_displacements
([z, cmap])add_fault_ellipse
([faults])add_faults
(**kwargs)add_model
([z, cmap])Plot the model onto a map
add_scalar_field
(feature[, z])Plot the scalar field value on a map
Attributes
bounding_box
model
nsteps
xmax
xmin
ymax
ymin
- add_contour(feature, values, z=0, mask=None, **kwargs)#
Add an isoline of a scalar field to the map
- Parameters:
feature (GeologicalFeature) – the feature to isosurface
values (list) – list of values to contour
z (double/np.array, optional) – elevation of map, by default 0
- add_data(feature, val=True, grad=True, unfault=False, dip=True, **kwargs)#
Adds the data associated to the feature to the plot :param feature: the feature whose data you want to add :type feature: GeologicalFeature :param val: whether to add value data :type val: bool :param grad: whether to add gradient data :type grad: bool :param unfault: plot points in their restored location :type unfault: bool :param dip: whether to annotate the dip, default False :type dip: bool :param kwargs are passed to matplotlib functions and draw strike:
- add_model(z=0, cmap=None)#
Plot the model onto a map
- Parameters:
z (int/numpy array, optional) – height of the map surface (could also be a dem), by default 0
cmap (str/matplotlib colourmap, optional) – specify a colour map, by default ‘tab20’
- add_scalar_field(feature, z=0, **kwargs)#
Plot the scalar field value on a map
- Parameters:
feature (GeologicalFeature) – which feature to plot on the map
z (double/np.array) – height
kwargs