check_bipole

empymod.utils.check_bipole(inp, name, mx=None, verb=1)

Check finite-length dipole 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. [dipole-x0, dipole-x1, dipole-y0, dipole-y1, dipole-z0, dipole-z1].

namestr, {‘src’, ‘rec’}

Pole-type.

mxbool or string {False, True, ‘b’, ‘j’}

Dipole type. None is only for backwards compatibility, will be removed.

verb{0, 1, 2, 3, 4}

Level of verbosity.

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.

mxbool

Dipole flag electric / magnetic. Not returned if mx=None (backwards compatibility, will be removed).

xtypeNone or str

None (only mx applies), 'b', or 'j'. Not returned if mx=None (backwards compatibility, will be removed).