pycsamt.zonge.tipper#

Tipper Transfer Function Component.

This module provides the Tipper class for managing the magnetotelluric Tipper transfer function, which relates the vertical magnetic field (Hz) to the horizontal components (Hx, Hy).

Classes

Tipper([data, meta, name, verbose])

Geomagnetic transfer function (Tipper) component.
class pycsamt.zonge.tipper.Tipper(data=None, meta=None, *, name=None, verbose=False)[source]#

Bases: AVGComponentBase

Geomagnetic transfer function (Tipper) component.

The Tipper, also known as the induction vector, is a transfer function that relates the vertical component of the magnetic field (\(H_z\)) to the horizontal components (\(H_x\), \(H_y\)).

\[H_z = T_x H_x + T_y H_y\]

This class is designed to hold the complex Tipper components \(T_x\) and \(T_y\) after they have been calculated.

Variables:

ty (tx,) – The complex Tipper components for the x and y directions.

Parameters:

See also

pycsamt.zonge.avg.AMTAVG.calculate_tipper

The method used to compute the Tipper values.

read(source, meta=None, **kws)[source]#

Populate the Tipper component from a DataFrame.

This method expects a DataFrame that contains the calculated Tipper components, named ‘tx’ and ‘ty’. If these columns are missing, they will be created and filled with NaNs for structural consistency.

Parameters:
Return type:

None

write()[source]#

Serialise to a compact CSV block with a meta preamble.

Return type:

list[str]

property tx: Series[source]#

The complex Tipper component Tx.

property ty: Series[source]#

The complex Tipper component Ty.

to_xarray(*, coords=('station', 'freq'), attrs=None)[source]#

Convert the Tipper data into an xarray.Dataset.

Parameters: