ip_and_q#
- empymod.model.ip_and_q(**kwargs)[source]#
Return In-Phase and Quadrature components for provided model and system.
This wrapper calls
dipole
two times:1st: with xdirect=None for the secondary field Hs.
2nd: with xdirect=True, and only the first value of all model parameters and an empty depth-parameter for the primary field Hp. For the primary field, the co-planar field of the source configuration is used.
It then returns the real (in-phase) and imaginary (quadrature) components of the ratio Hs/Hp, scaled by scale.
This function takes the same input parameters as
dipole
; see the documentation of dipole for the descriptions. In addition, it takes a scale parameter.This function is only implemented for frequency-domain data of magnetic sources and receivers.
Note
This function is experimental. Please let us know if you encounter any issues when using this function!
Also note that for the primary field computation, the co-planar field of the source direction is used. Hence:
Hp for ab=44 is used for ab in [44, 54, 64],
Hp for ab=55 is used for ab in [45, 55, 65],
Hp for ab=66 is used for ab in [46, 56, 66].
- Parameters:
- All parametersSee
dipole
. Restrictions compared to
dipole
:ab has to be one of [44, 45, 46, 54, 55, 56, 64, 65, 66] (magnetic source and receiver).
xdirect is ignored; it is first set to None for Hs, and then to True for Hp.
signal has to be None (frequency domain); ft and ftarg have hence no effect.
- scalefloat, default: 1e3 (ppt)
Multiplication factor. E.g., 1e3 for ppt, 1e6 for ppm.
- All parametersSee
- Returns:
- IP, Qndarrays
In-phase and quadrature values.