2.30.7.1. pycsamt.map.config#

Configuration dataclasses for pycsamt.map.

Classes

ExportOptions(path[, format, width, height, ...])

Options used by figure export helpers.

ProfileMapOptions([quantity, component, ...])

Options for pseudosection and profile-view maps.

StationMapOptions([overlay, frequency, ...])

Options for 2-D station maps.

VolumeMapOptions([mode, quantity, ...])

Options for 3-D fence, block, and depth-slice maps.
class pycsamt.map.config.StationMapOptions(overlay='index', frequency=None, frequency_tolerance=None, depth=None, show_markers=True, component='xy', theme='light', backend='plotly', selected_id=None, line_filter=None, marker_size=10, basemap=None, cmap='plasma', value_range=None, log_color=False, opacity=0.92, show_labels=True, label_fontsize=8.0, label_rotation=0.0, show_profiles=True, elevation_mode='markers', show_contours=False, contour_image=False, contour_mode='filled+lines', contour_levels=12, contour_opacity=0.55, contour_interp='linear', contour_smooth=1.0, contour_grid_res=150, bearing=0.0, title='')[source]

Bases: object

Options for 2-D station maps.

Parameters:

  • overlay (str)

  • frequency (float | None)

  • frequency_tolerance (float | None)

  • depth (float | None)

  • show_markers (bool)

  • component (str)

  • theme (Literal['light', 'dark', 'publication'])

  • backend (Literal['plotly', 'matplotlib'])

  • selected_id (str | None)

  • line_filter (tuple[str, ...] | None)

  • marker_size (int)

  • basemap (str | None)

  • cmap (str)

  • value_range (tuple[float, float] | None)

  • log_color (bool)

  • opacity (float)

  • show_labels (bool)

  • label_fontsize (float)

  • label_rotation (float)

  • show_profiles (bool)

  • elevation_mode (Literal['markers', 'contours'])

  • show_contours (bool)

  • contour_image (bool)

  • contour_mode (str)

  • contour_levels (int)

  • contour_opacity (float)

  • contour_interp (str)

  • contour_smooth (float)

  • contour_grid_res (int)

  • bearing (float)

  • title (str)

overlay: str = 'index'
frequency: float | None = None
frequency_tolerance: float | None = None
depth: float | None = None
show_markers: bool = True
component: str = 'xy'
theme: Literal['light', 'dark', 'publication'] = 'light'
backend: Literal['plotly', 'matplotlib'] = 'plotly'
selected_id: str | None = None
line_filter: tuple[str, ...] | None = None
marker_size: int = 10
basemap: str | None = None
cmap: str = 'plasma'
value_range: tuple[float, float] | None = None
log_color: bool = False
opacity: float = 0.92
show_labels: bool = True
label_fontsize: float = 8.0
label_rotation: float = 0.0
show_profiles: bool = True
elevation_mode: Literal['markers', 'contours'] = 'markers'
show_contours: bool = False
contour_image: bool = False
contour_mode: str = 'filled+lines'
contour_levels: int = 12
contour_opacity: float = 0.55
contour_interp: str = 'linear'
contour_smooth: float = 1.0
contour_grid_res: int = 150
bearing: float = 0.0
title: str = ''
class pycsamt.map.config.ProfileMapOptions(quantity='rho', component='xy', components=('xy', 'yx'), theme='light', backend='plotly', period_range=None, phase_range=None, value_range=None, x_axis='station', log_rho=True, height_per_panel=260, show_errbar=False, cmap=None, by_line=False, line_cols=None)[source]

Bases: object

Options for pseudosection and profile-view maps.

Parameters:
quantity: str = 'rho'
component: str = 'xy'
components: tuple[str, ...] = ('xy', 'yx')
theme: Literal['light', 'dark', 'publication'] = 'light'
backend: Literal['plotly', 'matplotlib'] = 'plotly'
period_range: tuple[float, float] | None = None
phase_range: tuple[float, float] | None = None
value_range: tuple[float, float] | None = None
x_axis: Literal['station', 'distance'] = 'station'
log_rho: bool = True
height_per_panel: int = 260
show_errbar: bool = False
cmap: str | None = None
by_line: bool = False
line_cols: int | None = None
class pycsamt.map.config.VolumeMapOptions(mode='fence', quantity='resistivity', component='xy', theme='light', cmap='RdYlBu_r', depth_range=None, period_range=None, rho_range=None, iso_range=None, value_range=None, log_color=True, opacity=0.85, show_contours=False, show_labels=True, n_slices=5, surface_count=12, line_spacing=1.0, azimuth=0.0, topography=True, show_terrain=True, terrain_opacity=0.7, show_stations=False, station_symbol='diamond', station_size=4, station_color='#1f2937', station_labels=False, station_label_angle=0.0, station_label_fraction=1.0, station_label_names=None, max_stations=None, aspectmode='data', x_unit='m', depth_unit='m', smooth_sections=True, section_res=100, volume_smoothing=0.0, title='')[source]

Bases: object

Options for 3-D fence, block, and depth-slice maps.

Parameters:
mode: Literal['fence', 'block', 'depth', 'surface'] = 'fence'
quantity: str = 'resistivity'
component: str = 'xy'
theme: Literal['light', 'dark', 'publication'] = 'light'
cmap: str = 'RdYlBu_r'
depth_range: tuple[float, float] | None = None
period_range: tuple[float, float] | None = None
rho_range: tuple[float, float] | None = None
iso_range: tuple[float, float] | None = None
value_range: tuple[float, float] | None = None
log_color: bool = True
opacity: float = 0.85
show_contours: bool = False
show_labels: bool = True
n_slices: int = 5
surface_count: int = 12
line_spacing: float = 1.0
azimuth: float = 0.0
topography: bool = True
show_terrain: bool = True
terrain_opacity: float = 0.7
show_stations: bool = False
station_symbol: str = 'diamond'
station_size: int = 4
station_color: str = '#1f2937'
station_labels: bool = False
station_label_angle: float = 0.0
station_label_fraction: float = 1.0
station_label_names: tuple[str, ...] | None = None
max_stations: int | None = None
aspectmode: str = 'data'
x_unit: str = 'm'
depth_unit: str = 'm'
smooth_sections: bool = True
section_res: int = 100
volume_smoothing: float = 0.0
title: str = ''
class pycsamt.map.config.ExportOptions(path, format=None, width=None, height=None, scale=2.0, include_plotlyjs='cdn')[source]

Bases: object

Options used by figure export helpers.

Parameters:
path: str | Path
format: str | None = None
width: int | None = None
height: int | None = None
scale: float = 2.0
include_plotlyjs: str | bool = 'cdn'