watex.property.P

class watex.property.P(hl=None)

Data properties are values that are hidden to avoid modifications alongside the packages. Its was used for assertion, comparison etceteara. These are enumerated below into a property objects.

Is a property class that handles the Electrical resistivity profiling and Vertical Electrical Sounding attributes. Along the electrical, it deals with the electrical dipole arrangements, the data classsification and assert whether it is able to be read by the scripts. It is a lind of “asserter”. Accept data or reject data provided by the used indicated the way to sanitize it before feeding to the algorithm.

Parameters:

**frcolortags: Stands for flow rate colors tags. Values are**

‘#CED9EF’,’#9EB3DD’, ‘#3B70F2’, ‘#0A4CEF’.

ididctags: Stands for the list of index set in dictionary which encompasses

key and values of all different prefixes.

isation: List of prefixes used for indexing the stations in the Electrical resistivity profiling.

ieasting: List of prefixes used for indexing the easting coordinates array.

inorthing: List of prefixes used to index the northing coordinates.

iresistivity List of prefix used for indexing the apparent resistivity

values in the Electrical resistivity profiling data collected during the survey.

isren: Is the list of heads columns during the data collections. Any data

head Electrical resistivity profiling data provided should be converted into the following arangement:

station

resistivity

easting

northing

**isrll: Is the list of heads columns during the data collections. Any data**

head Electrical resistivity profiling data provided should be converted into the following arangement:

station

resistivity

longitude

latitude

P: Typing class for fectching the properties.

Examples

>>> from watex.property import P
>>> P.idicttags
... <property at 0x1ec1f2c3ae0>
>>> P().idictags
...
{'station': ['pk', 'sta', 'pos'], 'longitude': ['east', 'x', 'long', 'lon'],
 'latitude': ['north', 'y', 'lat'], 'resistivity': ['rho', 'app', 'res']}
>>> {k:v for k, v in  P.__dict__.items() if '__' not in k}
... {'_station': ['pk', 'sta', 'pos'],
     '_easting': ['east', 'x', 'long'],
     '_northing': ['north', 'y', 'lat'],
     '_resistivity': ['rho', 'app', 'res'],
     'frcolortags': <property at 0x1ec1f2fee00>,
     'idicttags': <property at 0x1ec1f2c3ae0>,
     'istation': <property at 0x1ec1f2c3ea0>,
     'ieasting': <property at 0x1ec1f2c39f0>,
     'inorthing': <property at 0x1ec1f2c3c70>,
     'iresistivity': <property at 0x1ec1f2c3e00>,
     'isenr': <property at 0x1ec1f2c3db0>}
>>> P().isrll
... ['station','resistivity','longitude','latitude']
>>> from watex.property import P
>>> pObj = P()
>>> P.idictags
... <property at 0x15b2248a450>
>>> pObj.idicttags
... {'station': ['pk', 'sta', 'pos'],
...     'resistivity': ['rho', 'app', 'res', 'se', 'sounding.values'],
...     'longitude': ['long', 'lon'],
...     'latitude': ['lat'],
...     'easting': ['east', 'x'],
...     'northing': ['north', 'y']}
>>> rphead = ['res', 'x', 'y', '']
>>> pObj (rphead) # sanitize the given resistivity profiling head data.
... ['resistivity', 'easting', 'northing']
>>> rphead = ['lat', 'x', 'rho', '']
... ['latitude', 'easting', 'resistivity']
>>> rphead= ['pos', 'x', 'lon', 'north', 'latitud', 'app.res' ]
>>> pObj (rphead)
... ['station', 'easting', 'longitude', 'northing', 'latitude', 'resistivity']
>>> # --> for sounding head assertion
>>> vshead=['ab', 's', 'rho', 'potential']
>>> pObj (vshead, kind ='ves')
... ['AB', 'resistivity'] # in the list of vshead,
... # only 'AB' and 'resistivity' columns are recognized.