watex.methods.em.ZC.remove_distortion#

ZC.remove_distortion(distortion, /, error=None, out=False, **kws)[source]#

Remove distortion D form an observed impedance tensor Z.

Allow to obtain the uperturbed “correct” \(Z_{0}\) expressed as:

\[Z = D * Z_{0}\]
Parameters:

  • distortion_tensor (np.ndarray(2, 2, dtype=real)) – Real distortion tensor as a 2x2

  • error (np.ndarray(2, 2, dtype=real), Optional) – Propagation of errors/uncertainties included

  • out (bool , default =False,) – Output new filtered EDI. Otherwise return Z collections objects of corrected Tensors.

Returns:

d, new_z, new_z_err –

  • input distortion tensor

  • impedance tensor with distorion removed

  • impedance tensor error after distortion is removed

If export=True, export to new EDI and return None.

Return type:

NDArray ( 2 x2 , dtype =real )

Examples

>>> import watex
>>> from watex.methods import ZC
>>> edi_sample = watex.fetch_data ('edis', samples =17 , return_data =True )
>>> zo = ZC ().fit(edi_sample)
>>> zo.ediObjs_[0].Z.z[:, 0, 1][:7]
array([10002.46 +9747.34j , 11679.44 +8714.329j, 15896.45 +3186.737j,
       21763.01 -4539.405j, 28209.36 -8494.808j, 19538.68 -2400.844j,
        8908.448+5251.157j])
        >>> distortion = np.array([[1.2, .5],[.35, 2.1]])
>>> zc = zo.remove_distortion (distortion)
>>> zc[0].z[:, 0, 1] [:7]
        array([ 9724.52643923+9439.96503198j, 11159.25927505+8431.1101919j ,
        14785.52643923+3145.38324094j, 19864.708742  -4265.80166311j,
        25632.53518124-8304.88093817j, 17889.15373134-2484.60144989j,
         8413.19671642+4925.46660981j])