watex.methods.em.EMAP.qc

EMAP.qc(tol=0.5, *, return_freq=False, return_ratio=False, to_log10=True)

Check the quality control of the collected EDIs.

Analyse the data in the EDI collection and return the quality control value. It indicates how percentage are the data to be representative.

Parameters:

• tol (float,) – the tolerance parameter. The value indicates the rate from which the data can be consider as meaningful. Preferably it should be less than 1 and greater than 0. At this value. Default is .5 means 50 %

• return_freq (bool, Default =False) – return the interpolated frequency if set to True.

• return_ratio (bool, default=False,) –

  return only the ratio of the representation of the data.

  Added in version 0.1.5.

• to_log10 (bool, default=False) – convert the interpolated frequency into a log10.

Returns:

return the quality control value and interpolated frequency if return_freq is set to True otherwise return the index of useless data.

Return type:

Tuple (float , index ) or (float, array-like, shape (N, ))

Examples

>>> from watex.methods.em import Processing
>>> pobj = Processing().fit('data/edis')
>>> f = pobj.getfullfrequency ()
>>> # len(f)
>>> # ... 55 # 55 frequencies
>>> c,_ = pobj.qc ( tol = .4 ) # mean 60% to consider the data as
>>> # representatives
>>> c  # the representative rate in the whole EDI- collection
>>> # ... 0.95 # the whole data at all stations is safe to 95%.
>>> # now check the interpolated frequency
>>> c, freq_new  = pobj.qc ( tol=.6 , return_freq =True)