SeismicLineView#
- class cegalprizm.investigator.SeismicLineView(investigation: cegalprizm.investigator.inv.investigation.Investigation)#
A class representing a SeismicLineView
The view defines how a seismic line 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
get_json()Gets the json string representing the current view
set_colorscale_location(inside_viewport, ...)Set where in the plot the points colorscale is to be shown.
set_crossline(value)Set the crossline to be displayed in the view
set_inline(value)Set the inline to be displayed in the view
set_interpolate_area_density(interpolate)Set whether the area density should be interpolated when shown in the view
set_left_wiggle_color(color)Set the color to be used for the left wiggle fill
set_property(property_name)Set the property to be shown in the view
set_right_wiggle_color(color)Set the color to be used for the right wiggle fill
show_area_density(show)Set whether the area density should be shown in the view
show_colorscale(show)Set whether the points colorscale is shown
show_colorscale_frame(show_frame)Set whether the frame should be shown around the points colorscale
show_left_wiggle_fill(show)Set whether the left wiggle should be filled
show_right_wiggle_fill(show)Set whether the right wiggle should be filled
show_wiggles(show)Set whether the seismic wiggles should be shown in the view
- copy()#
Create a copy of this view
- Returns
the copied view
- Return type
- get_json() str#
Gets the json string representing the current view
- Returns
The json string
- Return type
str
- set_colorscale_location(inside_viewport: bool, location: str)#
Set where in the plot the points colorscale is to be shown.
Valid locations outside viewport are ‘left’ or ‘right’ Valid locations inside viewport are ‘top-left’ or ‘top-right’ or ‘bottom-left’ or ‘bottom-right’
- Parameters
inside_viewport (bool) – If True, the colorscale will be shown inside the viewport
location (str) – A string indicating the desired location of the colorscale
- Raises
ValueError – if the location is not a valid string
- set_crossline(value: int)#
Set the crossline to be displayed in the view
- Parameters
value (int) – The crossline to be shown
- Raises
ValueError – if the value is not valid
- set_inline(value: int)#
Set the inline to be displayed in the view
- Parameters
value (int) – The inline to be shown
- Raises
ValueError – if the value is not valid
- set_interpolate_area_density(interpolate: bool)#
Set whether the area density should be interpolated when shown in the view
- Parameters
interpolate (bool) – Should the area density be interpolated
- set_left_wiggle_color(color: Union[int, str])#
Set the color to be used for the left wiggle fill
- Parameters
color (Union[int, str]) – Either the int value or the webcolor colorname to be used
- Raises
ValueError – if color is not an int or a recognised webcolor colorname
- set_property(property_name: str)#
Set the property to be shown in the view
- Parameters
property_name (str) – The name of the property to be displayed
- Raises
ValueError – if the property_name is not a valid
- set_right_wiggle_color(color: Union[int, str])#
Set the color to be used for the right wiggle fill
- Parameters
color (Union[int, str]) – Either the int value or the webcolor colorname to be used
- Raises
ValueError – if color is not an int or a recognised webcolor colorname
- show_area_density(show: bool)#
Set whether the area density should be shown in the view
- Parameters
show (bool) – Should the area density plot be shown
- show_colorscale(show: bool)#
Set whether the points colorscale is shown
- Parameters
show (bool) – Should the colorscale be shown
- show_colorscale_frame(show_frame: bool)#
Set whether the frame should be shown around the points colorscale
- Parameters
show (bool) – Should the colorscale be shown
- show_left_wiggle_fill(show: bool)#
Set whether the left wiggle should be filled
- Parameters
show (bool) – Should the left wiggle be filled
- show_right_wiggle_fill(show: bool)#
Set whether the right wiggle should be filled
- Parameters
show (bool) – Should the right wiggle be filled
- show_wiggles(show: bool)#
Set whether the seismic wiggles should be shown in the view
- Parameters
show (bool) – Should the wiggles be shown