SimPEG.utils.io_utils.read_dcip_xyz#
- SimPEG.utils.io_utils.read_dcip_xyz(file_name, data_type, a_headers=('XA', 'YA', 'ZA'), b_headers=('XB', 'YB', 'ZB'), m_headers=('XM', 'YM', 'ZM'), n_headers=('XN', 'YN', 'ZN'), data_header=None, uncertainties_header=None, dict_headers=None, is_surface_data=False)[source]#
Read 2D or 3D DC/IP data from XYZ-formatted file.
This function loads DC and/or IP data from XYZ-formatted data files into the SimPEG framework; i.e. each row defines the data for the unique electrode locations provided. This function is versatile enough to load 2D or 3D data. The data file may include elevations for the electrodes or be surface formatted. Columns containing data which are not defined as part of a
SimPEG.data.Dataobject may be loaded and output to a dictionary.- Parameters:
- file_name
str Path to the data file
- data_type{“volt”, “apparent_resistivity”, “apparent_chargeability”}
Type of data being loaded.
- a_headers
listortupleofstr A list or tuple of strings providing the headers of the A-electrode location columns; i.e. the X (, Y and Z) columns.
- b_headers
listortupleofstr A list or tuple of strings providing the headers of the B-electrode location columns; i.e. the X (, Y and Z) columns.
- m_headers
listortupleofstr A list or tuple of strings providing the headers of the M-electrode location columns; i.e. the X (, Y and Z) columns.
- n_headers
listortupleofstr A list or tuple of strings providing the headers of the N-electrode location columns; i.e. the X (, Y and Z) columns.
- data_header
str The header for the data column
- uncertainties_header
str The header for the column containing the data uncertainties
- dict_headers
listortupleofstr Provide the hearders for additional data columns that you would like to load and output to a dictionary.
- is_surface_databool
If
True, we assume electrode elevations are not supplied. That is, the header lists fora,b,mandnelectrode locations do not have headers for elevation columns.
- file_name
- Returns:
SimPEG.data.DataDC or IP data. The survey attribute associated with the data object will be an instance of
SimPEG.electromagnetics.static.resistivity.survey.SurveyorSimPEG.electromagnetics.static.induced_polarization.survey.SurveydictIf additional columns are loaded and output to a dictionary using the keyward argument dict_headers, the output of this function has the form (out_data, out_dict).
