LogTracksView#
- class cegalprizm.investigator.LogTracksView(investigation: cegalprizm.investigator.inv.investigation.Investigation)#
A class representing a LogTracksView
The view defines how log tracks should be displayed. It allows control of both what data should be displayed and how the the data should be rendered.
Functions
__init__(investigation)copy()Create a copy of this view
create_borehole_views([borehole_names])Creates a copy of this view for each borehole specified
create_property_views([property_names])Creates a copy of this view for each property specified
get_json()Gets the json string representing the current view
group_tracks_by(grouping)Set whether the tracks should be grouped by well or by property
set_boreholes(borehole_names)Set the boreholes to be shown in the view
set_grids(grid_names)Set the grids to be shown in the view
set_properties(property_names)Set the properties to be shown in the view
show_continuous_fill(show)Set whether the continuous tracks should be shown with a continuous fill
- copy()#
Create a copy of this view
- Returns
the copied view
- Return type
- create_borehole_views(borehole_names: Union[str, Sequence[str]] = 'all') List[cegalprizm.investigator.views.predefined_view_tuple.PredefinedViewTuple]#
Creates a copy of this view for each borehole specified
- Parameters
borehole_names (Union[str, Sequence[str]], optional) – Defaults to ‘all’. - ‘all’ will duplicate the view for all the valid boreholes from the investigation - a list of borehole names to be used
- Returns
a list of views; one per specified borehole
- Return type
List[PredefinedViewTuple]
- create_property_views(property_names: Union[str, Sequence[str]] = 'all') List[cegalprizm.investigator.views.predefined_view_tuple.PredefinedViewTuple]#
Creates a copy of this view for each property specified
- Parameters
property_names (Union[str, Sequence[str]], optional) – Defaults to ‘all’. - ‘all’ will duplicate the view for all the valid properties from the investigation - a list of property names to be used
- Returns
a list of views; one per specified property
- Return type
List[PredefinedViewTuple]
- get_json() str#
Gets the json string representing the current view
- Returns
The json string
- Return type
str
- group_tracks_by(grouping: str)#
Set whether the tracks should be grouped by well or by property
- Parameters
grouping (str) – A string describing how the log tracks should be shown
- Raises
ValueError – if grouping is not a valid string
- set_boreholes(borehole_names: Sequence[str])#
Set the boreholes to be shown in the view
- Parameters
borehole_names (Sequence[str]) – The names of the boreholes to be used
- Raises
ValueError – if the borehole_names is not a valid
- set_grids(grid_names: Sequence[str])#
Set the grids to be shown in the view
- Parameters
grid_names (Sequence[str]) – The names of the grids to be used
- Raises
ValueError – if the grid_names is not a valid
- set_properties(property_names: Sequence[str])#
Set the properties to be shown in the view
- Parameters
property_names (Sequence[str]) – The names of the properties to be used
- Raises
ValueError – if the property_names is not a valid
- show_continuous_fill(show: bool)#
Set whether the continuous tracks should be shown with a continuous fill
- Parameters
show (bool) – Should the continuous fill be shown