check_bipole¶
-
empymod.utils.
check_bipole
(inp, name)[source]¶ Check di-/bipole parameters.
This check-function is called from one of the modelling routines in
empymod.model
. Consult these modelling routines for a detailed description of the input parameters.- Parameters
- inplist of floats or arrays
Coordinates of inp (m): [dipole-x, dipole-y, dipole-z, azimuth, dip] or. [bipole-x0, bipole-x1, bipole-y0, bipole-y1, bipole-z0, bipole-z1].
- namestr, {‘src’, ‘rec’}
Pole-type.
- Returns
- inplist
As input, checked for type and length.
- ninpint
Number of inp.
- ninpzint
Number of inp depths (ninpz is either 1 or ninp).
- isdipolebool
True if inp is a dipole.