watex.methods.ERPCollection#

watex.methods.ERPCollection = <function ERPCollection>[source]#

Collection objects. The class collects all erp survey lines. Each erp is an singleton class object with their corresponding attributes. The goal is to build a container geao-elecricals to straigthforwardly given to watex.bases.features.GeoFeatures class.

Parameters:
  • listOferpfn (list, ndarray) – list of different erp files.

  • listOfposMinMax (list) –

    collection of different selected anomaly boundaries. If not provided, the auto will triggered. It’s recommanded to provided for all erp your convenient anomaly boundaries like:

    listOfposMinMax=[(90, 130), (10, 70), ...]
    

    where (90,130)``is boundaries of selected anomaly on the first `erp` line and ``(10,70) is the boundaries of the second erp survey line and so on.

  • erpObjs (list, ndarray) – Collection of objects from ERP. If objects are alread created. Gather them on a list and pass though the argument erpObjs.

  • arguments. (Holds others optionals infos passed as keyword) –

  • =================================== (====================== =============) –

  • Description (Attributes Type) –

  • ===================================

  • User (list_of_dipole_lengths list Collection of dipoleLength.) – can provide the distance between sites measurements as performed on investigations site. If given, the automaticall dipoleLength computation will be turned off.

  • name. (fnames array_like Array of erp survey lines) – If each survey name is the location name then will keep it.

  • numbers (id array_like Each erp obj reference) –

  • geo-electrical (erps_data nd.array Array composed of) – parameters. ndarray(nerp, 8) where num is the number of `erp`obj collected.

  • line (erpdf pd.DataFrame A dataFrame of collected erp) – and the number of lines correspond to the number of collected erp.

  • ===================================

  • of (It's posible to get from each erp collection the singular array) –

  • properties:: (different parameters considered as) –

    >>> from watex.methods.erp import ERP_collection as ERPC
    >>> erpcol = ERPC(listOferpfn='list|path|filename')
    >>> erpcol.survey_ids
    >>> erpcol.selectedPoints
    

:param List of the ERP_collection attribute properties: :param ==================== ============== ===================================: :param Properties Type Description: :param ==================== ============== ===================================: :param selectedPoints array_like Collection of Best anomaly: position points. :param survey_ids array_like Collection of all erp survey: survey ids. Note that each ids is

following by the prefix e.

Parameters:
  • standard (sfis array_like Collection of best anomaly) – fracturation index value.

  • power (powers array_like Collection of best anomaly) –

  • anomaly (magnitudes array_like Colection of best) – magnitude in ohm.m.

  • shape. (shapes array_like Collection of best anomaly) – For more details please refer to ERP.

  • type. (types array_like Collection of best anomaly) – Refer to ERP for more details.

  • =================================== (==================== ==============) –

Examples

>>> from watex.methods.erp import ERPCollection
>>> erpObjs =ERP_collection(listOferpfn= 'data/erp')
>>> erpObjs.erpdf
>>> erpObjs.survey_ids
... ['e2059734331848' 'e2059734099144' 'e2059734345608']