SimPEG.electromagnetics.static.utils.generate_survey_from_abmn_locations

SimPEG.electromagnetics.static.utils.generate_survey_from_abmn_locations(*, locations_a=None, locations_b=None, locations_m=None, locations_n=None, data_type=None, output_sorting=False)

Use A, B, M and N electrode locations to construct a 2D or 3D DC/IP survey.

Parameters

locations_anumpy.array

An (n, dim) numpy array containing A electrode locations

locations_bNone or numpy.array

An (n, dim) numpy array containing B electrode locations. If None, we assume all sources are Pole sources.

locations_mnumpy.array

An (n, dim) numpy array containing M electrode locations

locations_nnumpy.array

An (n, dim) numpy array containing N electrode locations. If None, we assume all receivers are Pole receivers.

data_type{‘volt’, ‘apparent_conductivity’, ‘apparent_resistivity’, ‘apparent_chargeability’}

Data type of the receivers.

output_sortingbool

This option is used if the ABMN locations are sorted during the creation of the survey and you would like to sort any data vectors associated with the electrode locations. If False, the function will output a SimPEG.electromagnetic.static.survey.Survey object. If True, the function will output a tuple containing the survey object and a numpy array (n,) that will sort the data vector to match the order of the electrodes in the survey.

Returns

survey

A SimPEG.electromagnetic.static.survey.Survey object

sort_index

A numpy array which defines any sorting that took place when creating the survey