pycsamt.tdem.plot#

Visualization helpers for time-domain EM data.

Functions

`plot_decay`(soundings, **kwargs)	Plot TEM decay curves.
`plot_elevation_profile`(data, **kwargs)	Plot station elevation along TEM survey profiles.
`plot_gate_profile`(data, **kwargs)	Plot selected TEMAVG gate profiles.
`plot_survey_map`(data, **kwargs)	Plot station coordinates from a TEM survey.
`plot_survey_overview`(data, **kwargs)	Plot a TEM survey map with an elevation-profile panel.
`plot_tem_dashboard`(avg, zplot, soundings, ...)	Plot a compact TDEM dashboard.
`plot_tem_z_section`(data, **kwargs)	Plot a TEMAVG `.Z` pseudo-section.
`plot_temavg_section`(data, **kwargs)	Plot a TEMAVG pseudo-section.
`plot_transformed_rho`(data, **kwargs)	Plot transformed apparent resistivity and phase.

Classes

`PlotDecayCurve`(soundings, *[, title, ...])	Plot one or more TEM decay curves on log-log axes.
`PlotElevationProfile`(data, *[, profiles, x, ...])	Plot TEM station elevation along one or more survey profiles.
`PlotGateProfile`(data, *[, windows, value, ...])	Plot selected TEMAVG windows as profiles along stations.
`PlotSurveyMap`(data, *[, color_by, annotate, ...])	Plot TEM station coordinates from a survey or coordinate table.
`PlotSurveyOverview`(data, *[, profile, ...])	Plot a TEM survey map with a matched elevation profile panel.
`PlotTEMAVGSection`(data, *[, value, y, ...])	Plot a TEMAVG pseudo-section from station-gate records.
`PlotTEMDashboard`(avg, zplot, soundings, *[, ...])	Create a compact multi-panel TDEM real-data dashboard.
`PlotTEMZSection`(data, *[, value, y, ...])	Plot a ZPLOT `.Z` pseudo-section.
`PlotTransformedRho`(data, *[, show_phase, ...])	Plot transformed apparent resistivity and optional phase.
`StationTickConfig`([every, rotation, ...])	Station-axis tick configuration for TDEM plots.
`TDEMPlotBase`(*[, style, verbose, logger])	Base class shared by TDEM plot objects.
`TDEMPlotStyle`([primary, secondary, accent, ...])	Shared style values for TDEM figures.

class pycsamt.tdem.plot.PlotDecayCurve(soundings, *, title=None, figsize=None, y_mode='dBdt', show_error=True, style=None, verbose=0, logger=None)[source]#

Bases: TDEMPlotBase

Plot one or more TEM decay curves on log-log axes.

Parameters:

title (str | None)
figsize (tuple[float, float] | None)
y_mode (str)
show_error (bool)
style (TDEMPlotStyle | None)
verbose (int)
logger (object | None)

plot(ax=None)[source]#: Draw the decay curves and return the axes.

class pycsamt.tdem.plot.PlotElevationProfile(data, *, profiles=None, x='point', station_ticks=None, title='TEM elevation profile', figsize=None, style=None, verbose=0, logger=None)[source]#

Bases: TDEMPlotBase

Plot TEM station elevation along one or more survey profiles.

Parameters:

profiles (float | list[float] | None)
x (str)
station_ticks (StationTickConfig | None)
title (str | None)
figsize (tuple[float, float] | None)
style (TDEMPlotStyle | None)
verbose (int)
logger (object | None)

plot(ax=None)[source]#: Draw station elevation profiles and return the axes.

class pycsamt.tdem.plot.PlotGateProfile(data, *, windows=None, value='magnitude', absolute=True, log_y=True, title=None, figsize=None, station_ticks=None, style=None, verbose=0, logger=None)[source]#

Bases: TDEMPlotBase

Plot selected TEMAVG windows as profiles along stations.

Parameters:

windows (list[int] | None)
value (str)
absolute (bool)
log_y (bool)
title (str | None)
figsize (tuple[float, float] | None)
station_ticks (StationTickConfig | None)
style (TDEMPlotStyle | None)
verbose (int)
logger (object | None)

plot(ax=None)[source]#: Draw selected gate profiles and return the axes.

class pycsamt.tdem.plot.PlotSurveyMap(data, *, color_by='elevation', annotate=False, contour=False, contour_levels=8, contour_labels=True, marker_preset='survey', marker_size=None, marker_alpha=None, padding=0.04, colorbar_size='3.5%', colorbar_pad=0.04, colorbar_max_ticks=5, cmap=None, title='TEM survey map', figsize=None, style=None, verbose=0, logger=None)[source]#

Bases: TDEMPlotBase

Plot TEM station coordinates from a survey or coordinate table.

Parameters:

color_by (str)
annotate (bool)
contour (bool)
contour_levels (int | list[float])
contour_labels (bool)
marker_preset (str)
marker_size (float | None)
marker_alpha (float | None)
padding (float)
colorbar_size (str)
colorbar_pad (float)
colorbar_max_ticks (int | None)
cmap (str | None)
title (str | None)
figsize (tuple[float, float] | None)
style (TDEMPlotStyle | None)
verbose (int)
logger (object | None)

plot(ax=None, *, colorbar=True)[source]#

Draw the survey station map and return the axes.

Parameters:: colorbar (bool)

class pycsamt.tdem.plot.PlotSurveyOverview(data, *, profile=None, profile_x='point', map_kwargs=None, profile_kwargs=None, title='TEM survey overview', figsize=(10.0, 6.5), height_ratios=(1.25, 1.0), style=None, verbose=0, logger=None)[source]#

Bases: TDEMPlotBase

Plot a TEM survey map with a matched elevation profile panel.

Parameters:

profile (float | None)
profile_x (str)
map_kwargs (dict[str, Any] | None)
profile_kwargs (dict[str, Any] | None)
title (str | None)
figsize (tuple[float, float])
height_ratios (tuple[float, float])
style (TDEMPlotStyle | None)
verbose (int)
logger (object | None)

plot()[source]#: Draw the survey overview and return the figure.

class pycsamt.tdem.plot.PlotTEMDashboard(avg, zplot, soundings, *, title='TDEM profile dashboard', figsize=(12.0, 9.0), station_ticks=None, style=None, verbose=0, logger=None)[source]#

Bases: TDEMPlotBase

Create a compact multi-panel TDEM real-data dashboard.

Parameters:

title (str)
figsize (tuple[float, float])
station_ticks (StationTickConfig | None)
style (TDEMPlotStyle | None)
verbose (int)
logger (object | None)

plot()[source]#: Draw dashboard and return the figure.

class pycsamt.tdem.plot.PlotTEMAVGSection(data, *, value='ramp_app_res', y='depth', log_value=True, absolute=False, cmap=None, title=None, section='dynamic', figsize=None, station_ticks=None, style=None, verbose=0, logger=None)[source]#

Bases: TDEMPlotBase

Plot a TEMAVG pseudo-section from station-gate records.

Parameters:

value (str)
y (str)
log_value (bool)
absolute (bool)
cmap (str | None)
title (str | None)
section (str | SectionStyle)
figsize (tuple[float, float] | None)
station_ticks (StationTickConfig | None)
style (TDEMPlotStyle | None)
verbose (int)
logger (object | None)

plot(ax=None, *, colorbar=True)[source]#

Draw the pseudo-section and return the axes.

Parameters:: colorbar (bool)

class pycsamt.tdem.plot.PlotTEMZSection(data, *, value='magnitude', y='time_ms', log_value=True, absolute=True, cmap=None, title=None, section='dynamic', figsize=None, station_ticks=None, style=None, verbose=0, logger=None)[source]#

Bases: TDEMPlotBase

Plot a ZPLOT .Z pseudo-section.

Parameters:

value (str)
y (str)
log_value (bool)
absolute (bool)
cmap (str | None)
title (str | None)
section (str | SectionStyle)
figsize (tuple[float, float] | None)
station_ticks (StationTickConfig | None)
style (TDEMPlotStyle | None)
verbose (int)
logger (object | None)

plot(ax=None, *, colorbar=True)[source]#

Draw the ZPLOT pseudo-section and return the axes.

Parameters:: colorbar (bool)

class pycsamt.tdem.plot.PlotTransformedRho(data, *, show_phase=True, freq_convention='skin_depth', phase_mode='weidelt', use_control=False, panel_height_ratios=(3.0, 1.15), figsize=None, style=None, verbose=0, logger=None)[source]#

Bases: TDEMPlotBase

Plot transformed apparent resistivity and optional phase.

Parameters:

show_phase (bool)
freq_convention (str)
phase_mode (str)
use_control (bool)
panel_height_ratios (tuple[float, float])
figsize (tuple[float, float] | None)
style (TDEMPlotStyle | None)
verbose (int)
logger (object | None)

plot(axes=None)[source]#: Draw apparent resistivity and phase panels.

class pycsamt.tdem.plot.StationTickConfig(every='auto', rotation=45.0, fontsize=8, fmt='{:g}', max_ticks=12, preset='pseudosection', side=None, show_markers=True, use_shared_api=True, verbose=0, logger=None)[source]#

Bases: PyCSAMTObject

Station-axis tick configuration for TDEM plots.

Parameters:

every (int | str)
rotation (float)
fontsize (int)
fmt (str)
max_ticks (int)
preset (str)
side (str | None)
show_markers (bool)
use_shared_api (bool)
verbose (int)
logger (object | None)

every: int | str = 'auto'#

rotation: float = 45.0#

fontsize: int = 8#

fmt: str = '{:g}'#

max_ticks: int = 12#

preset: str = 'pseudosection'#

side: str | None = None#

show_markers: bool = True#

use_shared_api: bool = True#

verbose: int = 0#

logger: object | None = None#

compute_every(n, figwidth_in=10.0, max_label_len=4)[source]#

Return the station tick step.

Parameters:

n (int)
figwidth_in (float)
max_label_len (int)

Return type:

int

apply(ax, stations, *, labels=None, xlabel='Station', xlim=None)[source]#

Apply station ticks to ax.

Parameters:

stations (ndarray)
labels (list[str] | None)
xlabel (str)
xlim (tuple[float, float] | None)

Return type:

None

class pycsamt.tdem.plot.TDEMPlotStyle(primary='#2166ac', secondary='#d6604d', accent='#1b7837', warning='#b2182b', grid='#ededed', text='#1a1a1a', decay_cmap='viridis', section_cmap='RdYlBu_r', elevation_cmap='terrain', figsize_single=(7.0, 5.0), figsize_double=(7.0, 8.0), figsize_wide=(9.0, 4.5), multiline=None, verbose=0, logger=None)[source]#

Bases: PyCSAMTObject

Shared style values for TDEM figures.

Parameters:

primary (str)
secondary (str)
accent (str)
warning (str)
grid (str)
text (str)
decay_cmap (str)
section_cmap (str)
elevation_cmap (str)
figsize_single (tuple[float, float])
figsize_double (tuple[float, float])
figsize_wide (tuple[float, float])
multiline (object | None)
verbose (int)
logger (object | None)

primary: str = '#2166ac'#

secondary: str = '#d6604d'#

accent: str = '#1b7837'#

warning: str = '#b2182b'#

grid: str = '#ededed'#

text: str = '#1a1a1a'#

decay_cmap: str = 'viridis'#

section_cmap: str = 'RdYlBu_r'#

elevation_cmap: str = 'terrain'#

figsize_single: tuple[float, float] = (7.0, 5.0)#

figsize_double: tuple[float, float] = (7.0, 8.0)#

figsize_wide: tuple[float, float] = (9.0, 4.5)#

multiline: object | None = None#

verbose: int = 0#

logger: object | None = None#

colors(n)[source]#

Return n line colors.

Parameters:: n (int)
Return type:: list[str]

line_kwargs(idx, n, **overrides)[source]#

Return line kwargs from the package multiline style.

Parameters:

idx (int)
n (int)
overrides (Any)

Return type:

dict[str, Any]

pycsamt.tdem.plot.plot_decay(soundings, **kwargs)[source]#: Plot TEM decay curves.

pycsamt.tdem.plot.plot_elevation_profile(data, **kwargs)[source]#: Plot station elevation along TEM survey profiles.

pycsamt.tdem.plot.plot_gate_profile(data, **kwargs)[source]#: Plot selected TEMAVG gate profiles.

pycsamt.tdem.plot.plot_survey_map(data, **kwargs)[source]#: Plot station coordinates from a TEM survey.

pycsamt.tdem.plot.plot_survey_overview(data, **kwargs)[source]#: Plot a TEM survey map with an elevation-profile panel.

pycsamt.tdem.plot.plot_tem_dashboard(avg, zplot, soundings, **kwargs)[source]#: Plot a compact TDEM dashboard.

pycsamt.tdem.plot.plot_tem_z_section(data, **kwargs)[source]#: Plot a TEMAVG .Z pseudo-section.

pycsamt.tdem.plot.plot_temavg_section(data, **kwargs)[source]#: Plot a TEMAVG pseudo-section.

pycsamt.tdem.plot.plot_transformed_rho(data, **kwargs)[source]#: Plot transformed apparent resistivity and phase.