2. API reference#
This is the public class and function reference for pycsamt.
Use the search field to find an object by name, package, or description. For
conceptual guidance and worked examples, see the User Guide.
Runtime settings and the configure_* / reset_* pattern are documented
separately in API Guide. Private objects and test modules are
not included. Each entry links to the object’s canonical generated reference;
public facade paths are used when an object is implemented in a private module.
The owning public module is shown beneath its description and is searchable;
only supported public import paths are displayed. The catalogue is rebuilt
from each subpackage’s current public exports, including the IoT field stack.
Orchestrate a sequence of pycsamt agents as a named workflow. |
|
Plain-language entry point to the agent workflows. |
|
Standardised output returned by every pycsamt agent. |
|
Train an AI inverter on synthetic data then predict on observed sites. |
|
Detect anomalous (station, frequency) observations in MT data. |
|
Abstract base class for all pycsamt agents. |
|
Process multiple MT profiles through a shared agent chain. |
|
Generate a reproducible Python script from a completed workflow. |
|
Configure |
|
Parse a natural-language MT workflow request into a structured config. |
|
Run data quality control on a MT/AMT dataset. |
|
Denoise MT impedance data using classical or AI-based methods. |
|
Write processed Sites to EDI files on disk. |
|
Ensemble 1-D MT inversion with uncertainty bands. |
|
Compute the USD cost for one LLM call. |
|
Return a human-readable cost string. |
|
Run a 1-D, 2-D, or 3-D MT forward model. |
|
Select optimal periods from MT data for inversion. |
|
Return the resolved |
|
Two-stage AI + physics MT inversion. |
|
Classify a chat message into a |
|
Interpret a resistivity model in terms of geological formations. |
|
2-D MT profile inversion using a U-Net convolutional architecture. |
|
3-D MT profile inversion using a graph-convolutional network (GCN). |
|
Drive pycsamt.inversion physics-based backends. |
|
Compare two resistivity inversion results. |
|
Evaluate inversion quality: RMS, residual PT, misfit section. |
|
Prepare MT data files for 2-D / 3-D inversion codes. |
|
Assess and monitor an IoT-enabled EM field acquisition. |
|
Multi-modal MT joint inversion using DRCNN. |
|
Orchestrate a complete MARE2DEM 2.5-D EM inversion workflow. |
|
Browse, download, and run pre-trained EM inverters from the model zoo. |
|
Write a ModEM3D MT data file from EDI sources. |
|
Load MT data from any pycsamt-supported format and assess quality. |
|
Generate a complete Occam2D inversion input file set. |
|
Answer free-form questions about pycsamt v2. |
|
Run a full phase tensor, strike, and dimensionality survey analysis. |
|
PINN-based MT inversion without labelled data. |
|
LLM-assisted MT processing pipeline selection and interpretation. |
|
Generate a structured MT survey report from agent results. |
|
Reset |
|
Build horizontal resistivity depth-slice maps from 1-D inversion results. |
|
Bostick sensitivity kernels and vertical resolution analysis. |
|
Detect and correct galvanic static shift in MT/AMT data. |
|
Rotate impedance tensors and tipper vectors by a fixed strike angle. |
|
Analyse tipper vectors and plot induction arrows. |
|
Validate plan and optionally raise on errors. |
|
Intelligently route an NL request to the correct agent chain. |
|
Validated intermediate representation of a workflow request. |
|
One step in an |
|
Attach a right-side colorbar to ax using |
|
Profile-level unsupervised anomaly detector. |
|
Randomly zero-out a fraction of frequency channels. |
|
Mixup augmentation (Zhang et al. 2018). |
|
Add multiplicative log-Gaussian noise to feature amplitudes. |
|
Apply a random static shift to amplitude features. |
|
Abstract base class for EM neural network estimators. |
|
Abstract base class for ML-based EM data processing tasks. |
|
Build a symmetric adjacency matrix from 2-D station coordinates. |
|
Factory wrapper — call |
|
Return bounded measurement-by-dimensionality reliability. |
|
Sequentially apply a list of augmenters. |
|
Split conformal prediction wrapper for calibrated regression intervals. |
|
Integrity metadata for one external dataset artifact. |
|
Return the SHA-256 digest of deterministic canonical JSON. |
|
Immutable per-frequency/component complex z-score state. |
|
Identify a generated dataset and its complete reproducibility state. |
|
Describe the sign, units, and rotation convention of impedance data. |
|
Concatenate compatible surveys along the station axis. |
|
Normalized real/imaginary feature channels and their validity state. |
|
Build deterministic group-safe cross-validation test folds. |
|
Immutable train/validation/test assignment of geological realizations. |
|
Hash a file without loading the complete artifact into memory. |
|
Create a deterministic realization- or lineage-level random split. |
|
Summarize the usable fraction of a survey along each data axis. |
|
Validated MT/AMT observations on a common survey grid. |
|
RMSE on the resistivity sub-vector only (first |
|
Convert phase-tensor skew into compatibility with 2-D physics. |
|
MLP classifier for MT data dimensionality (1-D / 2-D / 3-D). |
|
Add complex, per-observation heteroscedastic Gaussian noise. |
|
Apply the full, ordered M3 corruption pipeline from a single seed. |
|
Mark stations, frequencies, or individual observations as missing. |
|
Apply jointly sampled field profiles and empirical error quantiles. |
|
Clamp the declared error to a minimum fraction of |
|
Inject a per-station real Groom & Bailey-style distortion matrix. |
|
Multiply every present component by a per-station real factor. |
|
Audit a raw survey and account for every included/excluded station. |
|
Compare two 1-D samples of the same feature quantitatively. |
|
Compare simulated and field surveys across several canonical features. |
|
Parameter ranges for one corruption pass over a |
|
Provenance of one applied |
|
Survey-wide aggregate of |
|
Collection of |
|
One corrupted survey and every sampled latent array. |
|
Quantitative comparison of one feature between two distributions. |
|
Derive plausible noise/dropout ranges from a real survey's QC. |
|
Estimate empirical static-shift and distortion spreads from real EDI. |
|
Whether every included station shares one frequency grid. |
|
Perturb a random fraction of valid observations by a large factor. |
|
Add Gaussian noise to station coordinates and elevation. |
|
One station dropped before the canonical survey bridge. |
|
Bridge EDI/ |
|
Complete M1 accounting of one survey's data quality. |
|
Download a pre-trained checkpoint to the local cache. |
|
Factory wrapper for the Dense Residual CNN. |
|
Prepare an Occam2D project for DUHI physics refinement. |
|
Summarize one completed DUHI Occam2D preparation. |
|
Lightweight context manager shorthand. |
|
Minimal checkpoint for saving/loading EM network state. |
|
PyTorch |
|
Convolutional autoencoder for MT impedance tensor denoising. |
|
1-D EM neural-network inverter. |
|
U-Net–based 2-D MT inversion estimator. |
|
ML-based per-frequency QC scorer for MT impedance data. |
|
Context manager that applies the shared EM plot style. |
|
Training loop manager for EM 1-D inversion networks. |
|
Deep ensemble of |
|
Predeclare one numerical condition required for an experiment gate. |
|
Pin an experiment to exact dataset preparation artifacts. |
|
Immutable source of truth for one reproducible inversion experiment. |
|
Immutable result of evaluating configured acceptance criteria. |
|
Derive stable, labeled child seeds from one experiment root seed. |
|
Factory wrapper for the fully-convolutional 1-D EM network. |
|
Graph-convolutional 3-D MT inversion estimator. |
|
Factory that builds a PyTorch or TensorFlow GCN. |
|
One generated benchmark resistivity model with provenance. |
|
Immutable generated scalar field with complete generation provenance. |
|
Calculate an unbinned empirical directional semivariogram. |
|
Empirical semivariance along one canonical geological axis. |
|
Define the electrical distribution of one stratigraphic unit. |
|
Define a rotated 2-D elliptical or 3-D ellipsoidal electrical body. |
|
Anisotropic Gaussian spatial-correlation model. |
|
Generate one deterministic ID or structural-OOD geology. |
|
Generate a deterministic anisotropic Gaussian random field. |
|
Generate a correlated 2-D section or 3-D layered electrical volume. |
|
Immutable regular cell-centre grid for 2-D or 3-D geological priors. |
|
Insert electrical lenses into a layered model with explicit overlap rules. |
|
Interpolate projected elevation samples onto a geological grid. |
|
Immutable discretized layered electrical geology. |
|
Immutable layered model after one or more lens insertions. |
|
Immutable terrain elevation raster aligned to a geological grid. |
|
Extract station elevations with |
|
Return metadata for a registered pre-trained model. |
|
Multi-modal joint inversion estimator based on DRCNN. |
|
Per-column RMSE vector. |
|
Return a dict of available pre-trained models. |
|
Penalize predicted values that violate a boundary constraint. |
|
Configurable, callable boundary-condition penalty. |
|
Penalize deviation between empirical and nominal coverage. |
|
Return inverse-depth weights normalized to sum to one. |
|
Compute a heteroscedastic Gaussian negative log-likelihood. |
|
Penalize first-difference magnitude along one grid axis. |
|
Masked, weighted Huber loss, robust to outlier cells. |
|
Masked, weighted mean/summed absolute error. |
|
Masked, weighted mean/summed squared error. |
|
Configurable, callable masked model data-fit loss. |
|
Immutable scalar result of a model data-fit loss. |
|
Compute |
|
Compare predicted and observed complex impedance responses. |
|
Configurable, callable response-consistency loss. |
|
Immutable scalar result of a response-consistency loss. |
|
Configurable combination of gradient and TV regularizers. |
|
Immutable scalar result of a spatial regularization loss. |
|
Penalize anisotropic total variation over every spatial axis. |
|
Configurable, callable heteroscedastic Gaussian NLL loss. |
|
Immutable scalar result of an uncertainty-aware loss. |
|
Mean absolute error, ignoring NaN. |
|
MSE loss that ignores |
|
Z-score normaliser that handles NaN values. |
|
Multi-panel comparison of true and predicted 1-D resistivity profiles. |
|
Plot a confusion matrix for a classification model. |
|
Plot train / validation loss curves from a trainer history dict. |
|
Horizontal bar chart of feature importances. |
|
Per-layer mean absolute error bar chart. |
|
Standalone learning-rate schedule plot. |
|
Plot a single true/predicted resistivity–depth pair on ax. |
|
Apparent-resistivity or phase pseudo-section plot. |
|
Scatter plots of predicted vs. true for each model parameter. |
|
Plot a 2-D resistivity section. |
|
Side-by-side comparison of true and predicted 2-D resistivity sections. |
|
1-D prediction curve with uncertainty bands. |
|
Gaussianization normalising flow for calibrated posterior sampling. |
|
Extract an impedance feature array from a site collection. |
|
Coefficient of determination R², ignoring NaN. |
|
Apply an augmenter with probability p. |
|
Normalised RMSE: |
|
Factory wrapper for the 1-D residual CNN. |
|
Root mean square error, ignoring NaN. |
|
Compute all scalar metrics and return as a dict. |
|
Factory wrapper for the 2-D U-Net. |
|
Return per-layer masked MAE along one grid axis. |
|
Return per-layer masked RMSE along one grid axis. |
|
Compute empirical coverage of Gaussian predictive intervals. |
|
Score inputs and flag those outside the training support. |
|
Score how far new inputs fall from the training distribution. |
|
Immutable out-of-distribution screening result. |
|
Return the masked mean predictive standard deviation. |
|
Summarize synthetic-recovery quality for one grid pair. |
|
Immutable synthetic-recovery diagnostics for one grid pair. |
|
Build a full calibration report for Gaussian predictive intervals. |
|
Immutable calibration report for Gaussian predictive intervals. |
|
Break complex-impedance residuals down by station/frequency/ component. |
|
|
Build a |
Immutable per-axis complex-impedance residual diagnostics. |
|
Compute the mean structural similarity index (SSIM). |
|
Format-neutral collection of airborne EM flight lines. |
|
One airborne flight line with navigation and sparse EM records. |
|
One sample-aligned airborne EM scientific record. |
|
Describe one concrete native airborne delivery format. |
|
Compact scientific inventory of an airborne object. |
|
One structural/metadata QC finding. |
|
Common structural QC report for an airborne dataset. |
|
One airborne flight-line sample, read directly from its EMTF. |
|
Ordered collection of |
|
Describe one scientific airborne-EM technology contract. |
|
Assess common structural completeness and metadata consistency. |
|
Return native formats with a registered reader. |
|
Return native formats with a registered writer. |
|
Detect a registered native format using detectors, then extensions. |
|
Return one canonical technology, or report/ignore mixed content. |
|
Normalize arbitrary airborne input to an |
|
Return a native format definition by name or alias, or |
|
Return a technology definition by canonical name or alias. |
|
Return canonical technologies explicitly or safely identified. |
|
Return a compact inventory for dataset, line, record, or EMTF object. |
|
Return registered native formats, optionally for one technology. |
|
Return registered technologies in registration order. |
|
Sample-aligned navigation and attitude information for one line. |
|
Read one verified native airborne delivery into the common dataset. |
|
Register a concrete native airborne file/delivery format. |
|
Register one scientific technology definition. |
|
Write a dataset through a verified native airborne writer. |
|
Global LLM configuration singleton for all pycsamt agents. |
|
Global LLM configuration singleton for all pycsamt agents. |
|
Decorate a function so dataframe-like returns become |
|
A pyCSAMT dataframe view that keeps pandas behavior intact. |
|
Container for named result parts, including one or more tables. |
|
Friendly public facade over an |
|
Package-wide policy for dataframe-like public API views. |
|
Build / processing execution settings. |
|
Return an |
|
Attach verbose, no-color, format, and output-dir to a command. |
|
Configure |
|
Configure the global API view backend. |
|
Configure |
|
Configure the live |
|
Configure |
|
Configure |
|
Configure |
|
Configure and return a copy of the live default style. |
|
Configure and return the global ordering singleton. |
|
Configure the global |
|
Configure |
|
Configure |
|
Configure |
|
Configure |
|
Configure the global |
|
Rendering and optional labeling settings for contour overlays. |
|
Consistent before/after visual pair for any 1-D correction workflow. |
|
Draw a structured mesh: an optional color fill, optional cell edges. |
|
Draw an unstructured triangular mesh: color fill and/or cell edges. |
|
Return |
|
Return |
|
A Click Path type for a directory that contains EDI files. |
|
A Click Path type that additionally requires a |
|
Add the text, JSON, or CSV output-format option to a Click command. |
|
Small immutable profile describing a dataframe. |
|
Parse a |
|
Control the 1-D frequency/period axis. |
|
Return a public APIFrame for a geology catalog. |
|
Alias for |
|
Build a |
|
Visual parameters for 1-D hydrogeophysical profile plots. |
|
Visual parameters for 2-D hydrogeophysical colour sections. |
|
Complete visual bundle for one hydrogeophysical interpretation preset. |
|
Yield items, optionally wrapped by a |
|
(Re-)load a config file into |
|
Logging / verbosity settings. |
|
Conditionally wrap data as an |
|
Cell-boundary line layer of a mesh display. |
|
Color-fill layer of a mesh display. |
|
Complete visual-control bundle for one mesh-display preset. |
|
Small mixin for attaching free-form object metadata. |
|
Consistent colours and markers for MT impedance components and modes. |
|
Gradient-first coloring for multi-line (multi-station / multi-profile) plots. |
|
Add the positive |
|
Add the |
|
Add the |
|
Validated Matplotlib properties for one Occam1D visual layer. |
|
Complete visual policy for Occam1D model and diagnostic figures. |
|
Add the writable |
|
Output format and destination settings. |
|
Add the |
|
Visual style for phase-tensor ellipse plots (psection, map, summary). |
|
Control how phase values are wrapped and displayed. |
|
Runtime configuration for the pyCSAMT pipeline engine. |
|
Runtime configuration for the pyCSAMT pipeline engine. |
|
Global plot-export configuration singleton for pyCSAMT. |
|
Return whether progress should be displayed. |
|
Package-wide policy for |
|
Configuration for terminal progress display. |
|
Package-wide CLI configuration container. |
|
Package-wide contour presets and live default style. |
|
Package-wide plotting-view control container. |
|
Package-wide visual control container for hydro-geophysical plots. |
|
Package-wide mesh-display control container. |
|
Root object for lightweight pyCSAMT API behavior. |
|
Registry and mutable default for Occam1D visual presets. |
|
Package-wide section-view control container. |
|
Package-wide station rendering control container. |
|
Global visual-style container for pyCSAMT. |
|
Return a public APIFrame wrapper around metadata quality rows. |
|
Alias for |
|
Visual style for raw, unprocessed EM observations. |
|
Read one EDI file and return an |
|
Read many EDI files and return a public survey view. |
|
Alias for |
|
Reset |
|
Reset the global API view backend. |
|
Reset |
|
Restore package contour defaults. |
|
Reset |
|
Reset |
|
Reset |
|
Restore the default pyCSAMT Occam1D style. |
|
Reset the global ordering policy to |
|
Reset |
|
Reset |
|
Reset |
|
Reset |
|
Reset |
|
Reset |
|
Reset |
|
Resolve |
|
Control apparent-resistivity display scale. |
|
Visual style bundle shared by all pycsamt rose diagram functions. |
|
Save a pyCSAMT figure using the global |
|
Axis behavior for section-like plots. |
|
Colorbar geometry and tick-density controls. |
|
Figure geometry for section-like plots. |
|
Complete visual-control bundle for one section preset. |
|
Set the global raster DPI on |
|
Set the global export format(s) on |
|
Set the global output directory on |
|
Global site-ordering strategy and automatic-line thresholds. |
|
Return a public APIFrame wrapper around |
|
Station-axis tick, label, and marker configuration. |
|
Parse a comma-separated list of station identifiers. |
|
Marker style used to draw stations along a profile axis. |
|
Return a |
|
Copy a named contour preset into the live default style. |
|
Activate a named preset in |
|
Select a named Occam1D style as the live default. |
|
Apply a named full-package style preset to |
|
Add the repeatable |
|
Wrap dataframe-like data using the configured API view backend. |
|
Wrap phase values into |
|
Wrap a mapping of result parts as an |
|
Write a template config file with the current |
|
Detect the best available backend and activate it. |
|
Return a list of available deep-learning backends. |
|
Return the name of the currently active backend. |
|
Return the concrete |
|
Return version strings for installed backends. |
|
Return availability status for all known backends. |
|
Return |
|
Set the active AI backend. |
|
Build a |
|
Mixin for containers of items that implement |
|
Mixin for single items convertible to and from bundles. |
|
Context manager for temporary configuration overrides. |
|
Update configuration fields with validation. |
|
Global configuration container for |
|
Minimal base class for PyCSAMT objects and mixins. |
|
Disk-backed |
|
Return the adapter factory for a key. |
|
Return the live |
|
Return the registered packer for |
|
Best-effort classification for common MT/EM artefacts. |
|
List registered adapters with readable names. |
|
List available packers as a mapping of kind to signatures. |
|
Container mapping record ids to |
|
Interface for loading and saving |
|
Common electromagnetic and MT utilities. |
|
Serialize an object to |
|
A single registry item with identifiers and metadata. |
|
Register a format adapter that yields an EDI object or collection. |
|
Register a serializer/deserializer pair for a given |
|
High-level helper to manage a file-backed registry. |
|
Convenience façade over |
|
Reset the global configuration to factory defaults. |
|
Rules to validate and synthesize station names. |
|
Lightweight, neutral payload for transfer functions. |
|
Serialize the current configuration to a plain dict. |
|
Dispatch |
|
Template utilities for AVG/J -> EDI transformations. |
|
Deserialize an object from |
|
Return |
|
Describe one electromagnetic transfer-function data type. |
|
Convert a historical SEG EDI object/path into |
|
Format-neutral electromagnetic transfer-function document. |
|
Return a backward-compatible |
|
Convert |
|
Read EMTF XML without routing the document through EDI. |
|
Build a deterministic EMTF XML element tree from an |
|
Serialize |
|
Return a registered definition by semantic tag, code, or alias. |
|
Return the inverse of |
|
Return the FCU |
|
Return a copy of registered data types keyed by semantic tag. |
|
Convenience wrapper around |
|
Recover Z/T and full covariance from an EDI SPECTRA container. |
|
Register and return an EMTF data-type definition. |
|
Resolve FCU local/remote channel roles from SPECTRA channel order. |
|
Rotate an inverse-signal or residual covariance matrix family. |
|
Rotate all primary transfer functions in an |
|
Rotate one matrix-valued transfer function and supported estimates. |
|
Per-period input and output matrices used in an EMTF rotation. |
|
Convert EDI SPECTRA to the format-neutral EMTF scientific model. |
|
Resolved local, remote, and output channel indices. |
|
Numerical result of one FCU-compatible SPECTRA recovery. |
|
Represent a frequency-indexed statistical estimate. |
|
Represent one matrix-valued electromagnetic transfer function. |
|
Write an |
|
Convenience wrapper around |
|
Return the theoretical Berdichevsky-determinant admittance table. |
|
Return a Swift (1967)-style skew table for the admittance tensor. |
|
Return a tidy per-(line, sample, frequency) admittance table. |
|
Return per-station, per-frequency AFMAG tilt angles as a table. |
|
Align a tensor component to a reference frequency grid. |
|
Per-frequency anisotropy metrics for a set of CSAMT sites. |
|
Per-station summary of anisotropy metrics. |
|
Apply one EMAP-style spatial filter to MT/AMT sites. |
|
Remove fitted Groom-Bailey galvanic distortion from impedance tensors. |
|
Apply pre-computed static-shift correction factors to sites. |
|
Normalised array factor AF_n for an N-element linear PAS (eq. |
|
Return a new |
|
Inter-element phase shift β [rad] to steer the main lobe to θ_m (eq. |
|
Bostick depth estimate per station per frequency from measured data. |
|
Bostick depth estimate D(f) from apparent resistivity. |
|
Validate a collection of EM objects and return their common kind. |
|
Classify CSAMT measurement zones per station per frequency. |
|
Compute the inter-channel coherence matrix. |
|
Inter-channel squared coherence as a tidy DataFrame. |
|
Return the coil-normal unit vector \(N_L\) in the local frame. |
|
Assess data quality across a collection of EDI/Z objects. |
|
Apply EMAP filtering only as strongly as confidence requires. |
|
Compute the composite confidence ratio from diagnostic scores. |
|
Return the motion-noise-corrected signal (Liu et al. 2018 Sec. |
|
Correct impedance tensor for CSAMT near-field contamination. |
|
Correct static shift by the AMA method. |
|
Remove static shift via Hanning adaptive moving-average (AMA) spatial filter. |
|
Empirical coverage fraction of a prediction interval (kouadio2025 eq. |
|
Per-station coverage summary. |
|
Summary depth-coverage statistics per station. |
|
Detect and classify near-surface distortion in CSAMT/MT apparent resistivity curves. |
|
Per-frequency source overprint β index for a set of CSAMT sites. |
|
Drop Z (and tipper) rows at user-specified frequencies. |
|
Drop rows whose frequency confidence is below |
|
Edit frequency rows and return diagnostics in one workflow. |
|
Summarize station-level changes after an EMAP-style filter. |
|
Container returned by confidence-gated EMAP filtering. |
|
Normalize a dataset or single line to an |
|
Normalize arbitrary user input to a |
|
Estimate AMA static-shift correction factors. |
|
Estimate static-shift factors via bilateral filtering. |
|
Estimate static-shift factors via locally-weighted regression (LOESS). |
|
Estimate static-shift factors via reference-median method. |
|
Return the ZYX "airline convention" attitude rotation matrix. |
|
Export station confidence to CSV and/or a Surfer DSAA grid. |
|
Export new EDI files from a batch of EDI objects and Z tensors. |
|
Return a list of |
|
Apply a fixed-length EMAP moving average along a profile. |
|
Flag/mask a station's low-frequency tipper band as motion-suspect. |
|
Return frequency-level confidence scores for EM stations. |
|
Return one row per original station-frequency edit decision. |
|
Summarize station-level changes after frequency editing. |
|
Invert the Bostick formula: return the frequency (Hz) that maps to a given depth for a background resistivity rho. |
|
Design a CSUMT frequency schedule that samples a set of target depths. |
|
Container returned by confidence-based frequency editing. |
|
Return the reference (clean) frequency grid for a collection. |
|
Return the local geomagnetic field unit vector \(B_E\). |
|
Estimate, and optionally apply, Groom-Bailey distortion correction. |
|
Estimate Groom-Bailey-style galvanic distortion parameters. |
|
Container returned by |
|
Remove frequency-domain outliers with a sliding Hampel filter. |
|
Build an |
|
Build an |
|
Build an |
|
Misfit/roughness/lambda sweep extracted from a real inversion log. |
|
Mask frequencies that fail the requested cross-station SNR vote. |
|
Boolean mask of frequencies with sufficient coherence. |
|
Set low-confidence frequency rows to NaN without changing the grid. |
|
Mask admittance/conductivity outside the usable MobileMT band. |
|
Mask/drop tipper frequencies outside the usable ZTEM band. |
|
Return \(\theta(t)\) in degrees. |
|
Return \(\cos\theta(t)\), the coil/field coupling factor. |
|
Score each station's exposure to motion-induced noise. |
|
Near-field correction factor for apparent resistivity (equatorial HED). |
|
Normalized apparent resistivity and subtracted phase (Wang & Lin 2023). |
|
Suppress mains-frequency harmonics in impedance and tipper data. |
|
Plot denoising changes in off-diagonal impedance as a pseudosection. |
|
Plot harmonic-noise reduction by station and mains harmonic. |
|
Plot the station-by-station SNR gain produced by denoising. |
|
Compare raw and denoised off-diagonal curves for one station. |
|
Overlay lower and upper noise envelopes on an existing period axis. |
|
Highlight gaps in spectral coverage on an existing QC plot. |
|
Ground-wave / surface-wave amplitude ratio β_Ey (%). |
|
Parse and validate a tensor request, returning name and component. |
|
Total normalised far-field pattern of an N-element PAS. |
|
Hilbert-transform "phase-rotated" ZTEM profile at one frequency. |
|
Draw a labeled reference phase-tensor ellipse. |
|
Plot before/after/delta AFMAG tilt pseudosections. |
|
Polar view of AFMAG tilt: azimuth and magnitude vs. period. |
|
Plot the classic AFMAG flight-line tilt-angle profile. |
|
Plot an AFMAG tilt-angle pseudosection (station x log-period). |
|
Plot anisotropy metric pseudo-section (station × frequency). |
|
Apparent-anisotropy pseudosection: log₁₀(ρa_XY / ρa_YX). |
|
Apparent-resistivity polar diagram: ρa(θ) petals per period. |
|
Plot squared coherence for selected channel pairs. |
|
Pseudo-section of coherence across stations (station × period). |
|
Plot confidence diagnostics from tensor errors for EM data. |
|
Plot line-wide confidence statistics for each period sample. |
|
Plot publication-style maps of confidence and its components. |
|
Map station-level confidence at geographic or projected coordinates. |
|
Compare presence and composite confidence on matched station maps. |
|
Profile confidence-ratio (CR) scatter plot along the survey line. |
|
Plot cross-station response consistency as a fan diagram. |
|
Plot frequency coverage and data availability as a pseudosection. |
|
Horizontal ranking of the deepest Bostick depth reached per station. |
|
Pseudosection of Bostick depth across stations and periods/frequencies. |
|
Dimensionality classification mapped to Bostick depth space. |
|
1-D / 2-D / 3-D ternary classification diagram. |
|
Galvanic-distortion decomposition radar chart. |
|
Plot a before/after EMAP filter station profile. |
|
Plot before/after/delta pseudo-sections for an EMAP filter. |
|
Pseudosection of CSAMT field zones across stations and frequencies. |
|
Plot frequency confidence as a station-period pseudo-section. |
|
Plot dropped, masked, recovered, and kept frequency decisions. |
|
Plot station-level before/after frequency-edit summary. |
|
Visualize which requested target depths survive the CSUMT band filter applied by |
|
Pseudo-section of a gradient apparent resistivity quantity. |
|
Double-Mohr-circle diagram of the MT impedance tensor. |
|
2×2 panel: Parkinson/Wiese × Real/Imaginary conventions. |
|
Map-view induction arrows at one period. |
|
Map-view induction arrows from |
|
Stacked multi-period induction vector map. |
|
Rose diagram of induction arrow azimuths (all stations & periods). |
|
Rose diagram of induction arrow directions from Spectra objects. |
|
Period × station pseudo-section coloured by |T| magnitude. |
|
Plot one admittance component along one flight line. |
|
Plot an apparent-conductivity pseudosection for one flight line. |
|
Plot the admittance skew profile along one flight line. |
|
Plot \(\theta(t)\) and \(\cos\theta(t)\) for attitude data. |
|
Map each station's motion-noise susceptibility score. |
|
Multi-row aligned pseudosection: ρa, φ, |β|, θ, SNR. |
|
Pseudosection of normalized ρ_a and subtracted phase (Wang & Lin 2023). |
|
Bar chart of the NS index per station, colored by distortion type. |
|
Plot source overprint β pseudo-section (station × frequency). |
|
Publication-quality phase-tensor map at a single period. |
|
Phase-tensor ellipse pseudo-section (Caldwell et al. 2004 style). |
|
Publication-quality phase-tensor θ rose diagram. |
|
Single-station phase-tensor ellipse strip vs period. |
|
Phase-tensor ellipse strips for several stations, grouped by profile. |
|
Polar coverage plot: angle ∝ log₁₀(f), radius ∝ ρ_a,obs. |
|
Polar rose diagram of relative residuals (ε = (ρ_pred − ρ_obs)/ρ_obs × 100 %). |
|
Plot the power spectral density per channel. |
|
Pseudo-section of PSD across stations (station × period). |
|
Phase-tensor period clock: PT ellipses on concentric rings. |
|
Create a compact multi-panel quality-control summary for a survey. |
|
Plot one or more radiation patterns in polar or Cartesian format. |
|
Plot raw or processed 1-D rho/phase panels by station. |
|
Single-station MT/CSAMT "full response" overview figure. |
|
Plot impedance response panels with station-level tipper rows. |
|
Bode consistency diagram: observed ρa/φ vs Bostick-predicted φ. |
|
Bostick-sensitivity-kernel pseudosection. |
|
Plot the distribution of signal-to-noise ratios across survey data. |
|
Visualise the full cross-spectral density matrix at one frequency. |
|
Per-station 1-D apparent-resistivity curves: before and after correction. |
|
Two- or three-panel pseudo-section comparison for static-shift correction. |
|
Plot per-station static-shift correction amplitudes as a bar chart. |
|
Plot pseudosection of static-shift change (corrected minus original). |
|
Plot apparent resistivity against period on a polar grid. |
|
Plot before-and-after apparent-resistivity curves for a single station. |
|
Four-panel summary figure for static-shift correction. |
|
Plot a 2-by-3 confidence dashboard for one station. |
|
Plot confidence components versus period for one station. |
|
Full four-component impedance tensor + tipper response for one station. |
|
Plot tensors for one station: resistivity/phase or Z real/imag. |
|
Plot strike angles from invariants and phase tensor as rose/polar diagrams. |
|
Rose diagram: Strike (Z), PT Azimuth, and, if present, Tipper Strike. |
|
Geoelectric-strike director field over station and period. |
|
Publication-quality rose diagram of geoelectric strike direction. |
|
Multi-method strike stability band diagram. |
|
Compact multi-metric survey fingerprint grid. |
|
Plot station inventory counts and the observed period coverage map. |
|
Plot tensors for one station (compat wrapper). |
|
Inter-station transfer-function coherence network map. |
|
Phase-tensor θ rose grid — one pycsamt-styled rose per frequency decade. |
|
Plot the induction tipper magnitude and phase from spectra. |
|
Polar view: tipper azimuth (angle) and magnitude (radius) vs period. |
|
Polar tipper from a |
|
Mean relative interval width per frequency band (horizon-drift analogue). |
|
Map XY/YX crossover behaviour across stations and frequencies. |
|
Plot apparent resistivity and phase recovered from spectra. |
|
Four-panel impedance rotation-invariants pseudosection. |
|
Argand-space trajectory of MT impedance components. |
|
Plot before/after \(|T|\) pseudosections around the ZTEM usable band. |
|
Plot the ZTEM total-divergence / Peaker flight-line profile. |
|
Plot a ZTEM total-divergence pseudosection (station x log-period). |
|
Compare several flight lines' divergence pseudosections at once. |
|
Plot a Sattel and Witherly (2012, Fig. |
|
Legault et al. (2012, Fig. |
|
Plot raw vs. Hilbert-phase-rotated ZTEM response at one frequency. |
|
Legault et al. (2012, Fig. |
|
Summarise dimensionality and strike checks before 2-D inversion. |
|
Power spectral density per channel as a tidy DataFrame. |
|
Draw a period-vs-station pseudosection. |
|
Recover recoverable frequency rows using trusted neighboring rows. |
|
Resolve style to a |
|
Per-frequency coverage of observed ρ_a within predicted quantile bounds. |
|
Per-frequency relative error between observed and predicted ρ_a. |
|
Vertical (log-frequency) apparent resistivity gradient. |
|
Joint vertical-transverse apparent resistivity gradient. |
|
Transverse (along-line) apparent resistivity gradient. |
|
Visual style bundle shared by all pycsamt rose diagram functions. |
|
2-D horizontal-plane directivity D₀ = 2π U_max / ∫ U(θ) dθ (eq. |
|
Far-field element pattern for a single finite-length SDAS (eq. |
|
Return the simulated motion-induced noise voltage \(V(t)\). |
|
Smooth apparent resistivity and phase trends, then rebuild |
|
SNR improvement of an N-element PAS relative to a single SDAS [dB]. |
|
Signal-to-noise ratio estimated from squared coherence. |
|
Per-station summary of source overprint metrics. |
|
Compact per-frequency summary table. |
|
Correct sites for static shift and plot a comparison pseudo-section. |
|
Estimate correction and plot per-station shift profile. |
|
Estimate static-shift correction and plot delta pseudosection. |
|
Estimate correction and plot before/after curves for one station. |
|
Return station-level confidence scores for EM transfer functions. |
|
All main-lobe broadside angles [degrees] for the given PAS configuration. |
|
Build a 2-D matrix (freq × station) from a tensor collection. |
|
Along-profile ZTEM total-divergence / Peaker table. |
|
Apply a trimmed EMAP moving average along a profile. |
|
Vertical resolution ΔD between adjacent frequencies per station. |
|
Vertical resolution ΔD between two adjacent frequencies. |
|
Effective real wavenumber k [m⁻¹] for CSAMT or free-space propagation. |
|
Wrap phase values to a target range with a given periodic base. |
|
Legault et al. (2012, Fig. |
|
Transform PCBH paths into PCSF x/y/depth coordinates. |
|
Match a parsed |
|
Import a LAS 2.0 curve subset while retaining curve metadata. |
|
Import a combined collar-and-interval CSV as a PCBH document. |
|
Import joined collar, survey, log, structure, sample, assay tables. |
|
Build a |
|
Build a render model with a short-lived builder. |
|
SHA-256 hex digest of a model-checkpoint file, streamed in chunks. |
|
Optional cached 3-D volume synthesized from stacked lines. |
|
Return a short multi-line human summary of sk. |
|
Generate a 3-D centerline for borehole. |
|
Detect what path is and how it should convert to PCSF/PCSM. |
|
Return a model copy with a validated portable PCBH attachment. |
|
Return embedded PCBH data without resolving external resources. |
|
Single-profile rectilinear geometry (Occam2D / DUHI-via-Occam2D). |
|
Native 3-D tensor volume geometry (ModEM). |
|
Cross-strike offset (m) for each line, from real station lat/lon. |
|
One profile within a |
|
Regrid a |
|
Describe the AI/DL model that produced a resistivity result. |
|
Reconstruct a profiles dict from a |
|
A set of profiles plus real line geometry (fence/block views). |
|
Convert a |
|
Flatten any |
|
Backend-neutral inversion-result container (one PCSF file). |
|
Convert a |
|
Return a PCSF/PCSM file's |
|
Flat point cloud ready for a 3-D scatter view. |
|
Read a canonical PCBH JSON file. |
|
Read a |
|
Read a |
|
Read a |
|
Parse a |
|
Return a model copy with an external PCBH reference. |
|
Resolve any accepted |
|
Outcome of |
|
Resample every line onto the first line's own (x, z) grid. |
|
Survey station positions, shared across geometry kinds. |
|
Extract lon/lat/elevation from an already-geo-located |
|
Per-station real coordinates resolved from a topo source, ready to populate |
|
Build topography from an uploaded elevation file. |
|
Build a gridded-DEM |
|
Build topography from a |
|
Return |
|
Return |
|
Scalar-per-station topography (matches the existing convention in |
|
Gridded-DEM topography — a regular elevation surface independent of any station table. |
|
A parsed topo source, before it is matched to any station names. |
|
Native unstructured triangular mesh geometry (MARE2DEM). |
|
Export supported PCBH content as a relational CSV directory. |
|
Write WGS84 collar Points and trajectory LineStrings as GeoJSON. |
|
Write browser-ready glTF 2.0 ( |
|
Write inline PCBH curves, or an interval-derived LAS subset. |
|
Atomically write a canonical PCBH JSON file. |
|
Write a |
|
Write a |
|
Write interval tubes as ASCII VTK XML PolyData ( |
|
Convenience wrapper: add Gaussian noise at a given relative level. |
|
Apply a named or pre-built noise model to a forward response. |
|
1-D controlled-source AMT forward solver. |
|
Frequency-dependent noise model for MT/CSAMT training data. |
|
Collect settings that define a 1-D forward modelling / dataset run. |
|
Collect settings for a 2-D MT finite-difference forward run. |
|
Collect settings for a quasi-3D MT forward modelling run. |
|
Numpy container for a batch of (features, targets) EM samples. |
|
Container for the output of a 1-D forward solver. |
|
Output of the 2-D MT forward solver. |
|
Full (approximate) impedance tensor from the 3-D MT forward solver. |
|
Add relative Gaussian noise to an EM forward response. |
|
Generate a batch of synthetic (data, model) pairs for ML training. |
|
Generate a pseudo-3D synthetic dataset for |
|
Non-uniform 2-D finite-difference grid for MT forward modelling. |
|
Non-uniform 3-D finite-difference grid for MT forward modelling. |
|
1-D layered earth model. |
|
Return cell widths for one padding strip. |
|
Configure solver-independent result acceptance rules. |
|
Declare a Maxwell adapter's supported physical and numerical scope. |
|
Store one lazy backend factory and its availability probe. |
|
Thread-safe registry of lazy Maxwell backend factories. |
|
Base class for adapters that run a trusted external solver process. |
|
Base class enforcing common preflight and postflight validation. |
|
Configure retries and concurrency for |
|
Summarize one |
|
Store errors measured against one analytic reference. |
|
Record the auditable outcome of one backend benchmark. |
|
Aggregate ordered outcomes from one backend benchmark run. |
|
Define quantitative acceptance limits for one benchmark. |
|
Build a real, graded, quality FEM mesh via Shewchuk's Triangle. |
|
Build a padded Maxwell mesh from a geological cell-centre model. |
|
Describe one complete cache entry. |
|
Summarize the current on-disk cache state. |
|
Adapt a trusted callable to the validated Maxwell backend interface. |
|
Describe whether a backend can solve a particular problem. |
|
Create a registered Maxwell adapter lazily. |
|
Configure how an external solver executable is located and run. |
|
Record one external-process execution attempt. |
|
Ordered, JSON-persistable record of every terminal batch failure. |
|
Store canonical impedance predictions from a Maxwell backend. |
|
Build a uniform-earth analytic benchmark. |
|
Return analytic plane-wave impedance of a uniform half-space. |
|
Build a laterally uniform layered-earth benchmark. |
|
Return analytic 1-D MT impedance by upward layer recursion. |
|
Describe registered Maxwell backends without creating them. |
|
Build a zero-argument availability probe for backend registration. |
|
Adapter wrapping the external MARE2DEM 2.5-D triangular-mesh solver. |
|
Runtime-checkable interface implemented by Maxwell adapters. |
|
Define one immutable problem and its expected impedance. |
|
Describe a rectilinear finite-volume or finite-element mesh. |
|
Define one isotropic frequency-domain MT boundary-value problem. |
|
Manage a validated, content-addressed result cache. |
|
Configure geometric padding, air treatment, and quality targets. |
|
Summarize numerical mesh quality and skin-depth resolution. |
|
Adapter wrapping the external ModEM 3-D forward solver. |
|
Validated 2-D MT adapter over the in-repo finite-difference solver. |
|
Research-only 3-D MT adapter (see module docstring for scope). |
|
Best-effort external solver version string for provenance. |
|
Record one problem's terminal solve failure. |
|
Define named receiver locations in mesh coordinates. |
|
Register a lazy backend in the process-wide registry. |
|
Register |
|
Register |
|
Register |
|
Register |
|
Resolve an external solver executable to a concrete file path. |
|
Run an ordered benchmark collection with one backend version. |
|
Calculate electromagnetic skin depth for a non-magnetic conductor. |
|
Solve many problems robustly, with retries and a failure manifest. |
|
Record convergence information for every frequency and source solve. |
|
Store a padded mesh, conductivity, regions, and construction record. |
|
In-house 2-D triangular-mesh MT FEM adapter (research-only). |
|
Describe an unstructured 2-D triangular finite-element mesh. |
|
Define one isotropic frequency-domain MT problem on a triangular mesh. |
|
Remove a backend from the process-wide registry. |
|
1-D magnetotelluric forward solver (plane-wave, isotropic earth). |
|
2-D magnetotelluric finite-difference forward solver. |
|
Quasi-3D magnetotelluric forward solver. |
|
Log-space (multiplicative) Gaussian noise. |
|
Plot one or more 1-D layered earth models as resistivity-depth profiles. |
|
Plot the 2-D resistivity model on a colour map. |
|
Three orthogonal slice panels for a 3-D resistivity model. |
|
Plot a 2-D MT pseudo-section (period × station distance). |
|
Plot 1-D MT/CSAMT apparent resistivity and phase vs period (or frequency). |
|
3-panel figure combining model depth profile, ρ_a, and phase. |
|
Map-view scatter of ρ_a or phase at one frequency. |
|
Plot ρ_a (or phase) vs station distance at selected frequencies. |
|
Period × station pseudo-section for one 3-D response component. |
|
2 × 2 map panel showing all four impedance tensor components. |
|
Numpy container for a pseudo-3D multi-station survey dataset. |
|
1-D central-loop TEM forward solver (step-off waveform). |
|
Borehole / well log with depth-interval data. |
|
Borehole / well log with depth-interval data. |
|
A single depth interval in a borehole log. |
|
Where a fault crosses the 2-D profile. |
|
A single depth interval in a borehole log. |
|
One geological unit in a pseudo-stratigraphic log. |
|
A linear structural field measurement. |
|
One geological unit in a pseudo-stratigraphic log. |
|
Extensible rock physics database for EM resistivity interpretation. |
|
A single entry in the rock physics database. |
|
Per-station pseudo-stratigraphic depth profile. |
|
Extensible rock physics database for EM resistivity interpretation. |
|
A single entry in the rock physics database. |
|
Per-station pseudo-stratigraphic depth profile. |
|
A planar structural field measurement. |
|
Collection of structural evidence along one survey profile. |
|
Contiguous aquifer-favourable interval at one station/profile column. |
|
Raise |
|
Calibrate petrophysical parameters to match hydrogeological field data. |
|
Electrical conductivity of formation water (e.g., from an EC log or sample). |
|
Quantitative hydrogeological model from an EM resistivity section. |
|
Quantitative hydrogeological output of one EM resistivity section. |
|
Metadata about a completed fusion operation. |
|
Hydrogeological interpretation product for one resistivity model. |
|
Rule-based hydrogeophysical interpreter for EM resistivity sections. |
|
One classified hydrogeophysical cell. |
|
Constrain a 2-D EM resistivity model with borehole TRES values. |
|
Monte Carlo uncertainty propagation for a quantitative EM hydro model. |
|
Fuse two EM resistivity models onto a single depth grid. |
|
All petrophysical and hydraulic parameters needed by |
|
Transmissivity (and optionally storativity) from a pumping test. |
|
Unified 2-D resistivity model container. |
|
Hydraulic conductivity K from a slug test or bail test. |
|
Time-lapse EM analysis for hydrogeological change detection. |
|
Prior distribution specification for Monte Carlo sampling. |
|
Ensemble statistics from a |
|
Piezometer or well water-level measurement. |
|
Return registered backend names. |
|
Build a 1-D TensorMesh-like object and positive-downward centres. |
|
Build a 3-D TensorMesh-like object around station coordinates. |
|
Build the finite-difference 2-D grid used by built-in inversion. |
|
Return errors for one data component using config settings. |
|
Return a boolean mask for one component using config mask settings. |
|
Expand a layered starting model into a 2-D core resistivity grid. |
|
Return geometrically growing positive depth cell widths. |
|
Normalized EM observation container. |
|
Build an |
|
Component-aware data-error settings for inversion backends. |
|
Return the backend class for name using lazy imports. |
|
Source-of-truth configuration for |
|
Common convergence-history container. |
|
Lightweight mesh/grid descriptor. |
|
Backend-neutral post-inversion result. |
|
Backend-neutral uncertainty and sensitivity diagnostics. |
|
Execute a configured EM inversion backend. |
|
Starting or recovered layered-earth model. |
|
Built-in 1-D MT inversion workflow. |
|
Built-in stitched 2-D MT inversion workflow. |
|
ModEM 3-D MT inversion workflow. |
|
Return the pyGIMLi lambda value using shared option names. |
|
Backend-neutral regularization settings. |
|
Build backend-neutral controls from a config object. |
|
Return unweighted residual terms for smooth/damped/blocky penalties. |
|
Return the scalar penalty weight for least-squares backends. |
|
Run an inversion in one call. |
|
SimPEG 3-D MT inversion workflow. |
|
Starting or recovered layered-earth model. |
|
Container of un‐modifiable I/O settings and lookup tables. |
|
Detect the canonical inversion-model format from source content. |
|
Detect the canonical transfer-function format from source content. |
|
Return a registered format by canonical name or alias. |
|
Resolve a writable format from a target filename extension. |
|
Return a registered format by canonical name or alias. |
|
Resolve a writable format from a target filename extension. |
|
Return stable public information about registered formats. |
|
Return stable public information about registered formats. |
|
Definition of one registered inversion-model serialization. |
|
Read a table‐like file into a pandas object using the Config parser map. |
|
Read a supported electromagnetic transfer-function source. |
|
Read a supported electromagnetic transfer-function source. |
|
Register one inversion-model reader definition. |
|
Register one transfer-function reader definition. |
|
Definition of one registered transfer-function serialization. |
|
Write a pandas‐like object to disk using Config writers. |
|
Write a transfer-function object through a registered serializer. |
|
Write a transfer-function object through a registered serializer. |
|
Reproducible manifest describing one IoT acquisition session. |
|
Metadata describing one raw acquisition record/window. |
|
Run the core AMT edge diagnostics on one channel and collate them. |
|
Flatten one or more |
|
Assess the stability of per-window impedance estimates. |
|
Assess transmitter current (and optional voltage) steadiness. |
|
Grade synchronisation from offset, drift, jitter, and GPS lock. |
|
Convenience wrapper around |
|
Supported authentication schemes. |
|
Common behaviour for telemetry transports. |
|
Assess many devices at once and return a status table. |
|
Assemble an |
|
Assemble an in-memory |
|
Construct a telemetry client for protocol. |
|
Detect ADC clipping / saturation in a channel. |
|
Proxy assessment of electrode contact quality. |
|
Classify each frequency as near, transition, or far field. |
|
Evaluate device clock status against a reference. |
|
Return |
|
Authentication credential with secret redaction. |
|
Run the core CSAMT edge diagnostics on one channel and collate them. |
|
Flatten one or more |
|
Run the CSEM offset-domain diagnostics for one frequency. |
|
Flatten one or more |
|
Seed a |
|
Return one row per device describing declared IoT capabilities. |
|
Survey-level IoT deployment metadata. |
|
Summarise GPS-lock dropouts across a sample sequence. |
|
Detect mains-frequency harmonics in a time series. |
|
Detect NaN gaps and stuck-value (flatline) runs in a channel. |
|
Check that recorded energy is present at each transmitted frequency. |
|
Configuration for one field IoT node or recorder gateway. |
|
Named power profile for a field node or recorder. |
|
Role of an IoT device in a field deployment. |
|
Return one row per channel from edge-processing results. |
|
Quality-control summary for one edge data channel. |
|
Acceptance state assigned by edge-side quality control. |
|
Configuration for lightweight field-side processing. |
|
Summary returned by |
|
Small edge-processing block for telemetry payload reduction. |
|
Return an EDI-survey summary as a pyCSAMT table. |
|
Electromagnetic survey methods recognised by IoT monitoring. |
|
Route IoT-acquired impedance through |
|
Power-budget inputs for a field IoT device. |
|
Estimated runtime and power draw. |
|
Estimate channel SNR in decibels. |
|
Estimate clock drift in parts-per-million. |
|
Estimate timing jitter as the std of drift-corrected offsets (ms). |
|
Estimate median local-reference clock offset in milliseconds. |
|
Estimate and tabulate energy budgets for multiple devices. |
|
Estimate runtime from battery, duty cycle, and optional solar input. |
|
Estimate the resolvable frequency band of a recording. |
|
Flag a static shift between the two apparent-resistivity modes. |
|
Discrete field event (state change, alarm, operator note). |
|
Severity levels for event telemetry. |
|
Build an acquisition manifest and write it to path. |
|
Write a manifest and per-station audits into out_dir. |
|
Write a single-station provenance audit to path (JSON). |
|
Seed a |
|
Build per-station EDIs from a session plus impedance estimates. |
|
Build a magnitude/phase-versus-offset curve and QC it. |
|
Stateful container for one IoT-enabled field acquisition session. |
|
Wave-propagation regime of a CSAMT measurement at one frequency. |
|
Result of |
|
Append/replay telemetry packets to a JSON-lines file. |
|
Result of |
|
Contamination measured at one powerline harmonic. |
|
Return the hex digest of data using algo. |
|
Return a tamper-evident hash chain over entries. |
|
Return a stable hash of mapping (key-sorted JSON, UTF-8). |
|
Hash a raw acquisition file and return its integrity record. |
|
Device-health telemetry (battery, temperature, link quality). |
|
POST telemetry packets to an HTTP(S) endpoint. |
|
Build a |
|
Result of |
|
IoT capability flags used in deployment reports. |
|
Supported telemetry protocol identifiers. |
|
Return a normalised QC-decision record for the audit trail. |
|
Return the |
|
Canonical acquisition characteristics for one EM method. |
|
Return monitoring statuses as a pyCSAMT table. |
|
Thresholds used to monitor AMT/MT/CSAMT telemetry streams. |
|
Overall status level for a monitored telemetry stream. |
|
Status returned by |
|
Publish/subscribe telemetry over MQTT. |
|
Result of |
|
Return telemetry packets as a pyCSAMT table. |
|
Telemetry packet categories used by pyCSAMT IoT workflows. |
|
Parse payload into the schema registered for kind. |
|
Plot edge quality-control decisions and channel metrics. |
|
Plot a compact IoT acquisition dashboard. |
|
Plot IoT energy budget, runtime, and power-state summaries. |
|
Plot clock offset, drift, jitter, GPS lock, and quality grades. |
|
Return energy estimates as a pyCSAMT table. |
|
Result of |
|
Energy-budget telemetry for a field node. |
|
Energy status for an IoT field device. |
|
Per-station occupation provenance for one field session. |
|
Edge quality-control telemetry for one acquisition window. |
|
Read an EDI survey into per-station summary records. |
|
Return a redaction placeholder when value is a non-empty secret. |
|
Return the payload schema registered for kind. |
|
Combined TLS + credential policy for telemetry transports. |
|
Send/receive telemetry over a serial port. |
|
Return an HMAC signature over the canonical JSON of mapping. |
|
Simulate one AMT channel: band-limited signal + noise + artefacts. |
|
Simulate a full AMT station: config, channel data, and packets. |
|
Simulate a monotonic-ish battery discharge curve with noise. |
|
Simulate paired reference/local clocks with drift, jitter, dropout. |
|
Simulate a network of AMT stations across one or more profiles. |
|
Return packets with a fraction randomly dropped. |
|
Return a powerline-noise time series (fundamental + harmonics). |
|
Electromagnetic skin depth in metres. |
|
Detection result for one expected transmitter frequency. |
|
Transmitter telemetry for a controlled-source (CSAMT/TDEM) survey. |
|
Result of |
|
Result of |
|
Return one row per station describing its acquisition metadata. |
|
Geospatial and acquisition metadata for one field station. |
|
Wrap a telemetry client with a persistent offline send buffer. |
|
Return one row per device from sync-status objects. |
|
Clock-synchronisation tolerances. |
|
Clock-synchronisation telemetry for a field node. |
|
Overall synchronisation grade for a device. |
|
Clock-synchronisation status for one device. |
|
Return per-decade sub-bands spanning a method's frequency band. |
|
Summarise telemetry packet counts by device and topic. |
|
Acknowledgement returned by a telemetry client. |
|
Generic recorder used for dry-run simulation and unmapped protocols. |
|
Monitor field telemetry from AMT, MT, CSAMT, and related surveys. |
|
A timestamped message emitted by an IoT-enabled field node. |
|
Base class for canonical telemetry payloads. |
|
Transport-layer security material for a telemetry client. |
|
Result of |
|
Return a canonicalised payload dictionary for kind. |
|
Return whether a |
|
Verify a signed manifest produced by |
|
Return whether signature is a valid HMAC of mapping under key. |
|
Send/receive telemetry over a WebSocket connection. |
|
Write an impedance tensor to a |
|
Return an EDI-backed |
|
Parse and serialize the top provenance comment line. |
|
Parse and serialize a single J-format head triple. |
|
Mixin that provides a |
|
Minimal container for one |
|
Parse and serialize the J-format information block. |
|
Mixin that provides an |
|
Convenience wrapper around |
|
Abstract base for A.G. |
|
Yield lines from a path, file‑like, or a sequence of strings. |
|
Abstract base for J-format data blocks. |
|
Container for a sequence of parsed J data blocks. |
|
Minimal stateful base for collections of J files. |
|
High-level collection of Jones J-format files. |
|
Mixin that provides folder/glob expansion and robust parsing orchestration for Jones J-format collections. |
|
Lightweight facade to manage Jones (J-format) components on a host object. |
|
Core scanner for J files that extracts light metadata. |
|
High-level J dispatcher for MT/SEG archives. |
|
Tolerant BLOCK parser and TF/R/Tipper builder. |
|
Lightweight helpers shared by J-format readers. |
|
Lightweight helpers for scanning Jones J-format text. |
|
Container for site properties parsed from J-format info. |
|
Parse a data‑type line like |
|
Resistivity/phase (R/S) block implementation. |
|
One parsed resistivity/phase row of a J R/S block. |
|
Transfer-function (Z/Q/C/T) block implementation. |
|
One parsed transfer-function row of a J Z/Q/C/T block. |
|
Return a copy of data with station elevations overridden. |
|
Resolve a style name into a (base style, raster layers) pair. |
|
Plotly geographic map layout settings. |
|
Build the concrete 3-D figure. |
|
Return layout settings for geographic station maps. |
|
Build an interpolated map contour overlay. |
|
Render a Surfer-style filled-contour PNG for a basemap image layer. |
|
Build a reusable profile-line overlay trace. |
|
Build the concrete profile-view figure. |
|
Build the concrete pseudosection figure. |
|
Build a reusable station-label overlay trace. |
|
Build a Plotly 2-D station map. |
|
Build a Plotly 3-D terrain mesh or surface. |
|
Return a parsed impedance component specification. |
|
Parsed impedance component request. |
|
Coordinate transform settings. |
|
Return normalized map data. |
|
Export station id/elevation/coordinates to CSV or HDF5. |
|
Export fig according to options. |
|
Options used by figure export helpers. |
|
Fetch station elevations online from their coordinates. |
|
Return a serializable figure dictionary. |
|
Nearest-frequency selection metadata. |
|
Station value and selected-frequency metadata. |
|
Group ModEM station names into survey lines. |
|
Interpolate scattered values to a regular grid. |
|
|
|
Launch the interactive map-view app. |
|
Alias for |
|
Build one combined |
|
Load a ModEM 3-D inversion result folder as a multi-line MapData. |
|
Builder object for 3-D survey maps. |
|
Normalized survey data shared by map renderers. |
|
A code-first session bound to one (multi-line) survey. |
|
Return the canonical map component name. |
|
Return an EPSG authority string. |
|
Loosely-normalized station id for fuzzy matching. |
|
Backward-compatible alias for |
|
Parse an uploaded elevation file into |
|
Build a 3-D map. |
|
Build a profile-view map. |
|
Build a resistivity or phase pseudosection. |
|
Build a 2-D station map. |
|
Build a 3-D volume map. |
|
A named sequence of stations in one profile. |
|
Builder object for profile maps. |
|
Options for pseudosection and profile-view maps. |
|
Reproject x, y from epsg to WGS84 lon/lat. |
|
Per-station resistivity on a horizontal slice at |
|
Return a human-readable CRS description. |
|
Return a |
|
Save a Matplotlib-like or Plotly-like figure as PNG. |
|
Select the closest finite positive frequency. |
|
Builder object for station-map figures. |
|
Options for 2-D station maps. |
|
A normalized station row used by map renderers. |
|
Transform coordinates between two CRS definitions. |
|
Return values with selected-frequency metadata. |
|
Builder object for 3-D survey maps. |
|
Options for 3-D fence, block, and depth-slice maps. |
|
Write a figure dictionary as JSON text. |
|
Write a Plotly-like figure to HTML. |
|
Write a Plotly-like image. |
|
Write a Plotly-like figure specification as JSON. |
|
Compute |
|
Return all bands in the registry that contain f Hz. |
|
Geographic bounding box in decimal degrees (WGS-84 default). |
|
Describe one electric, magnetic, or auxiliary EM channel. |
|
Quality metrics for a single impedance component. |
|
Copyright and usage conditions. |
|
Data-quality summary for a single MT station. |
|
Return the skin-depth DOI estimate in metres at frequency f. |
|
A named geological scenario for layered-Earth modelling. |
|
Return |
|
Specification of an EM geophysical frequency band. |
|
Return a |
|
Registry of geological formations for layered-Earth modelling. |
|
Structured descriptor for an EM acquisition system. |
|
Shortcut for |
|
Return sorted list of available preset keys. |
|
Geographic location and optional magnetic declination metadata. |
|
Normalize common Fourier sign-convention spellings. |
|
Describe the coordinate orientation of transfer-function data. |
|
Person contact information. |
|
Processing assumptions and software associated with an EMTF product. |
|
Describe creation and stewardship of a scientific data product. |
|
Return a |
|
Free-text transfer-function quality comment with optional author. |
|
Data-quality classification for one component or a whole station. |
|
Bibliographic reference information. |
|
Add or replace a |
|
Describe remote-reference processing when it was used. |
|
Access and query geological rock metadata: |
|
Specification for a single sensor (magnetic or electric). |
|
Original physical input/output channel geometry at a site. |
|
Site identity, acquisition interval, and geographic location. |
|
Software metadata. |
|
Campaign-level descriptor for an MT/AMT/CSAMT/TEM survey. |
|
Archival quality assessment attached to an EM transfer function. |
|
Return a sorted list of distinct step categories. |
|
Configure the global |
|
Load every |
|
Deterministic content hash of a Sites-like collection. |
|
Return the |
|
Return the method-aware |
|
Return the |
|
Return all available |
|
Return all registered |
|
Return all |
|
Read back previously logged run summaries, oldest first. |
|
Parse a JSON pipeline config file and return the raw dict. |
|
Import a Python config file and return its |
|
Parse a YAML pipeline config file and return the raw dict. |
|
Return the |
|
An ordered, configurable MT processing pipeline. |
|
Base class for pyCSAMT pipeline objects. |
|
Return value of |
|
Create a compact dashboard for a completed pipeline run. |
|
Plot per-step success status for a pipeline run. |
|
Plot elapsed time per pipeline step. |
|
Plot station counts entering and leaving each pipeline step. |
|
Outcome of loading one |
|
A named, ordered collection of pipeline steps. |
|
Return a formatted catalogue of all presets. |
|
Register the opt-in AI step(s) into the pipeline step registry. |
|
Register a third-party |
|
Reset |
|
Execute a named Stratagem preset in one call (convenience wrapper). |
|
A configured pipeline step. |
|
Return a sorted list of all step codes. |
|
Return a sorted list of all step names. |
|
Sharded, content-addressed disk cache for pipeline step outputs. |
|
Immutable record produced after one pipeline step runs. |
|
Immutable descriptor for one pipeline step. |
|
Return a formatted catalogue of all Stratagem presets. |
|
A |
|
Named configuration bundle for |
|
Remove a previously-registered step from the pipeline registry. |
|
Build a multi-site xarray Dataset from an iterable of EDIFile. |
|
An xarray accessor for convenient interaction with EDI datasets. |
|
High–level EDI dispatcher for SEG/EMAP/CSAMT archives. |
|
Lightweight registry and helpers used by EDI readers. |
|
Tolerant |
|
Profile helper for one or many |
|
Abstract base for SEG-EDI validation helpers. |
|
Reader/writer for generic |
|
Header container for |
|
Container for |
|
Read and write |
|
Minimal container for the |
|
Lightweight table view for station metadata derived from |
|
Container for |
|
Elevation profile helper. |
|
Minimal container for the |
|
Reader and writer for |
|
A mixin that adds convenient xarray exports to collection classes. |
|
Normalize heterogeneous EM sources into a common form. |
|
Create and return a |
|
Context-managed capture of key transformation outputs. |
|
Create and return a |
|
Select sites that fall inside an axis-aligned geographic box. |
|
Select sites whose stored chainage falls within a closed interval. |
|
Select sites that contain at least one data row with frequency inside a closed interval. |
|
Select sites by zero-based numeric indices, supporting negative indices. |
|
Select sites by matching station names against one or more patterns. |
|
Select sites using a user-supplied predicate function. |
|
Drop sites that are effectively empty. |
|
Recompute and rewrite EDI files using pyCSAMT conventions. |
|
Per-station outcome for an EDI recomputation workflow. |
|
Result returned by |
|
Replace missing or non-finite values in Z and/or tipper arrays with zeros or NaNs. |
|
Keep sites that contain at least one finite impedance value. |
|
Filter out sites whose maximum phase-error exceeds a threshold. |
|
Describe the metadata changes attempted for one station. |
|
Pack a set of sites into a zip archive using a filename template. |
|
Estimate phase slopes within a frequency band. |
|
Recompute one EDI object. |
|
Convenience function for |
|
Recompute apparent resistivity and phase from the impedance tensor Z for a single site. |
|
Rename a station using an explicit name or a policy function. |
|
Batch rename a collection of sites. |
|
Rename stations from a mapping, aligned sequence, or callable. |
|
Evaluate apparent resistivity at a target frequency. |
|
Rotate impedance tensor Z (and tipper T, if present) by an azimuthal angle in degrees. |
|
Rotate every site in a collection by an azimuthal angle in degrees. |
|
Subset the dataset along frequency by range or explicit indices, keeping all affected arrays aligned. |
|
Subset all sites in a collection along frequency, keeping arrays aligned. |
|
Set geographic coordinates on the EDI header. |
|
Batch set coordinates for a collection of sites. |
|
Project (easting, northing) to lon/lat and set a site's coords. |
|
Set site coordinates for many EDI files from a table. |
|
High-level wrapper for a single MT/CSAMT site backed by an |
|
Apply declarative, validated, and auditable EDI metadata changes. |
|
Lightweight wrapper exposing station-centric accessors and utilities for a single |
|
Statistics and display for a single |
|
Container for multiple |
|
Statistics and display for a |
|
Estimate a strike angle from impedance tensors. |
|
Summarize or tabulate tipper magnitudes. |
|
Unwrap site-like inputs to raw EDI objects. |
|
Update metadata for one site or EDI-like object. |
|
Apply metadata specifications to a station collection. |
|
Write a single site (EDI) to a target path. |
|
Write a collection of sites to a directory using a filename template. |
|
Inject GPS coordinates into WinGLink EDI files. |
|
Load a directory of WinGLink-exported EDI files as |
|
Rename Stratagem EDI files with a standardised naming convention. |
|
Write in-memory EDIFile objects to disk with optional HEAD overrides. |
|
Remove bad frequency bins from Stratagem AMT data. |
|
Multi-stage noise-removal pipeline for Stratagem AMT data. |
|
Station-level quality-control report for Stratagem AMT surveys. |
|
Estimate and remove static-shift from Stratagem AMT impedance data. |
|
Resolve the mapping between EDI acquisition order and GPS table rows. |
|
Parse raw Stratagem hardware files (19-column ASCII) for QC diagnostics. |
|
End-to-end Stratagem AMT survey processing pipeline. |
|
User-defined waveform supplied as paired time/current arrays. |
|
Rigorous TDEM → MT impedance via numerical Fourier cosine transform and Kramers-Kronig reconstruction (Meju 1996; Christensen 1990). |
|
Half-sine transmitter current (used by some CSEM / airborne systems). |
|
Return |
|
Return |
|
Return |
|
Convert TEM soundings to frequency-domain apparent impedance using the late-time apparent-resistivity approximation. |
|
Plot TEM decay curves. |
|
Plot station elevation along TEM survey profiles. |
|
Plot selected TEMAVG gate profiles. |
|
Plot station coordinates from a TEM survey. |
|
Plot a TEM survey map with an elevation-profile panel. |
|
Plot a compact TDEM dashboard. |
|
Plot a TEMAVG |
|
Plot a TEMAVG pseudo-section. |
|
Plot transformed apparent resistivity and phase. |
|
Plot one or more TEM decay curves on log-log axes. |
|
Plot TEM station elevation along one or more survey profiles. |
|
Plot selected TEMAVG windows as profiles along stations. |
|
Plot TEM station coordinates from a survey or coordinate table. |
|
Plot a TEM survey map with a matched elevation profile panel. |
|
Plot a TEMAVG pseudo-section from station-gate records. |
|
Create a compact multi-panel TDEM real-data dashboard. |
|
Plot a ZPLOT |
|
Plot transformed apparent resistivity and optional phase. |
|
Transmitter current with a finite linear ramp on switch-off. |
|
Read a TEM profile/point coordinate table. |
|
Read a TEMAVG folder and return station soundings. |
|
Read a directory of Zonge TEMAVG processed files. |
|
Ideal square-wave transmitter current (zero ramp time). |
|
Station-axis tick configuration for TDEM plots. |
|
Shared style values for TDEM figures. |
|
Processed content of one Zonge TEMAVG |
|
Result bundle returned by TEMAVG workflow helpers. |
|
One processed TEMAVG gate value. |
|
Coordinate metadata for one TEM station point. |
|
Collection of TEM station coordinates. |
|
Parsed TEMAVG processing log. |
|
One acquisition-summary row from a TEMAVG log. |
|
Unified TEM file reader with format auto-detection. |
|
Container for a single time-domain EM (TEM) sounding. |
|
Collection of processed TEM files from one survey folder. |
|
Convert one or more TEM soundings to a |
|
Parsed content of one TEMAVG contour |
|
One row from a TEMAVG contour |
|
Run a complete TEMAVG-to-frequency workflow. |
|
Draw rotated station name labels above marker positions. |
|
Resolve a model + topography source into a terrain-draped section. |
|
Package-wide topography rendering policy for 2-D section plots. |
|
Configure the global |
|
Transform a flat depth section into terrain-following coordinates. |
|
Overlay terrain on a depth-section axes (terrain-following frame). |
|
Add an elevation-profile strip above a pseudosection image axes. |
|
Compute along-profile cumulative distance (km) for each station. |
|
Extract per-station elevation (m a.s.l.) from a Sites or EDI collection. |
|
Return station name / ID strings in collection order. |
|
Return True if any station carries a meaningful non-zero elevation. |
|
Interpolate station elevations to arbitrary profile positions. |
|
Set data cells that lie above the terrain surface to NaN. |
|
Drape an arbitrary 2-D scalar field over real topography. |
|
Plot a resistivity model or inversion result draped over topography. |
|
Reset |
|
Return the terrain-draped z-coordinate for station marker positions. |
|
Return a smooth, deterministic elevation profile, metres. |
|
Package-wide topography rendering policy for 2-D section plots. |
|
Resolved, terrain-embedded 2-D resistivity section. |
|
Convert a Zonge |
|
Convert a Zonge |
|
Convert a Jones |
|
Convert a Jones |
|
Transform SEG spectra-EDI files to MT-impedance EDI files. |
|
Template utilities for AVG/J -> EDI transformations. |
|
Outcome of a batch spectra→impedance conversion. |
|
Transform raw MT field time series to impedance EDI files. |
|
Resistivity/phase container backed by complex Z. |
|
High-level impedance tensor container built on |
|
Apply an Adaptive Moving Average (AMA) filter. |
|
Transmitter current amplitude container (unit: A). |
|
Extends AVG with tensor components and analytical methods. |
|
A class for advanced processing of Zonge AVG data. |
|
High-level façade for a Zonge AVG/AMTAVG dataset. |
|
Abstract base class for a single AVG data component. |
|
A container for a tidy AVG table and its metadata. |
|
A structured, format-agnostic representation of a single row. |
|
Base class for AVG data handling and file writing. |
|
Enumeration/validator for classical CSAMT component labels. |
|
High-level aggregator for a complete Zonge AVG dataset. |
|
Dynamically provides all known aliases for canonical names. |
|
Apply a Fixed-Length Moving Average (FLMA) filter. |
|
Frequency axis manager (Hz) for AVG tables. |
|
Fetch all known aliases for a canonical column name. |
|
Determine a suitable reference frequency for static shift. |
|
Calculate Swift's skew for the impedance tensor. |
|
Calculate the geoelectric strike angle. |
|
Minimal provenance captured from banner / comment lines. |
|
Interpolate AVG data onto a regular log-spaced grid. |
|
Read a Zonge AVG file and return a tidy DataFrame and metadata. |
|
Impedance phase (\(\varphi\)) per component. |
|
Receiver electrode / coil metadata ( |
|
Apparent resistivity (\(\rho_a\)) per component. |
|
Encapsulate Zonge skip-flag quality codes. |
|
Smooth apparent resistivity using the Hilbert transform. |
|
One-dimensional survey-line geometry container. |
|
Project-level annotation block ( |
|
Survey-level configuration taken from AVG headers. |
|
Adds impedance-like tensor helpers to a component. |
|
Geomagnetic transfer function (Tipper) component. |
|
Apply a Trimmed Moving Average (TMA) filter. |
|
Transmitter loop / bipole metadata ( |
|
Serialize a DataFrame to a Zonge kind-2 AVG file. |
|
A foundational base class for Zonge data objects. |