pycsamt.emtools.gb#

Functions

apply_groom_bailey(sites[, table, band, ...])

Remove fitted Groom-Bailey galvanic distortion from impedance tensors.

groom_bailey_decomposition(sites, *[, ...])

Estimate, and optionally apply, Groom-Bailey distortion correction.

groom_bailey_table(sites, *[, band, ...])

Estimate Groom-Bailey-style galvanic distortion parameters.

Classes

GroomBaileyResult(sites, table, applied, method)

Container returned by groom_bailey_decomposition().
class pycsamt.emtools.gb.GroomBaileyResult(sites, table, applied, method)[source]#

Bases: object

Container returned by groom_bailey_decomposition().

Parameters:
sites: Any#
table: DataFrame#
applied: bool#
method: str#
property n_station: int[source]#

Number of stations with fitted distortion parameters.

summary()[source]#

Return a compact text summary.

Return type:

str

pycsamt.emtools.gb.groom_bailey_table(sites, *, band=None, rotate_deg=None, min_freq=4, max_iter=30, tol=1e-06, robust=True, recursive=True, on_dup='replace', strict=False, verbose=0, api=None)[source]#

Estimate Groom-Bailey-style galvanic distortion parameters.

The fitted model is

\[Z_\mathrm{obs}(f) \approx D\,Z_{2D}(f),\]

where D is a real, frequency-independent 2x2 distortion matrix and Z_2D is anti-diagonal at each frequency. The fitted matrix is decomposed into gain, twist, shear, and anisotropy-style parameters.

Parameters:
Return type:

Any

pycsamt.emtools.gb.apply_groom_bailey(sites, table=None, *, band=None, rotate_deg=None, min_freq=4, max_iter=30, tol=1e-06, robust=True, inplace=False, recursive=True, on_dup='replace', strict=False, verbose=0)[source]#

Remove fitted Groom-Bailey galvanic distortion from impedance tensors.

Parameters:
Return type:

Any

pycsamt.emtools.gb.groom_bailey_decomposition(sites, *, apply=False, band=None, rotate_deg=None, min_freq=4, max_iter=30, tol=1e-06, robust=True, inplace=False, recursive=True, on_dup='replace', strict=False, verbose=0)[source]#

Estimate, and optionally apply, Groom-Bailey distortion correction.

Parameters:
Return type:

GroomBaileyResult