TdemData

digraph inheritanceeb2965ddb0 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "Data" [URL="Data.html#geobipy.src.classes.data.dataset.Data.Data",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class defining a set of Data."]; "Point" -> "Data" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Point" [URL="../../pointcloud/Point.html#geobipy.src.classes.pointcloud.Point.Point",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="3D Point Cloud with x,y,z co-ordinates"]; "myObject" -> "Point" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TdemData" [URL="#geobipy.src.classes.data.dataset.TdemData.TdemData",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Time domain electro magnetic data set"]; "Data" -> "TdemData" [arrowsize=0.5,style="setlinewidth(0.5)"]; "myObject" [URL="../../core/myObject.html#geobipy.src.classes.core.myObject.myObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ABC" -> "myObject" [arrowsize=0.5,style="setlinewidth(0.5)"]; }
class geobipy.src.classes.data.dataset.TdemData.TdemData(system=None, **kwargs)

Time domain electro magnetic data set

A time domain data set with easting, northing, height, and elevation values. Each sounding in the data set can be given a receiver and transmitter loop.

TdemData(nPoints=1, nTimes=[1], nSystems=1)

Parameters:

  • nPoints (int, optional) – Number of soundings in the data file

  • nTimes (array of ints, optional) – Array of size nSystemsx1 containing the number of time gates in each system

  • nSystem (int, optional) – Number of measurement systems

Returns:

out – Time domain data set

Return type:

TdemData

See also

read()

For information on file format

Bcast(world, root=0, system=None)

Broadcast the TdemData using MPI

Scatterv(starts, chunks, world, root=0, system=None)

Scatterv the TdemData using MPI

append(other)

Append pointclouds together

Parameters:

other (geobipy.PointCloud3D) – 3D pointcloud

createHdf(parent, myName, withPosterior=True, fillvalue=None)

Create the hdf group metadata in file parent: HDF object to create a group inside myName: Name of the group

property data

The data.

datapoint(index=None, fiducial=None)

Get the ith data point from the data set

Parameters:

  • index (int, optional) – Index of the data point to get.

  • fiducial (float, optional) – Fiducial of the data point to get.

Returns:

out – The data point.

Return type:

geobipy.FdemDataPoint

Raises:

Exception – If neither an index or fiducial are given.

estimateAdditiveError()

Uses the late times after 1ms to estimate the additive errors and error bounds in the data.

static fileInformation()

Description of PointCloud3D file.

Returns:

out – File description.

Return type:

str

classmethod fromHdf(grp, **kwargs)

Reads the object from a HDF group

mapChannel(channel, system=0, *args, **kwargs)

Create a map of the specified data channel

property nPoints

Get the number of points

off_time(system=0)

Obtain the times from the system file

pcolor(component=0, system=0, yAxis='index', **kwargs)

Plot the data in the given system as a 2D array

plot_data(*args, **kwargs)

Plots the data

Parameters:

  • system (int) – System to plot

  • channels (sequence of ints) – Channels to plot

plot_predicted(*args, **kwargs)

Plots the specifed predicted data channels as a line plot.

Plots the channels along a specified co-ordinate e.g. ‘x’. A legend is auto generated.

Parameters:

  • xAxis (str) – If xAxis is ‘index’, returns numpy.arange(self.nPoints) If xAxis is ‘x’, returns self.x If xAxis is ‘y’, returns self.y If xAxis is ‘z’, returns self.z If xAxis is ‘r2d’, returns cumulative distance along the line in 2D using x and y. If xAxis is ‘r3d’, returns cumulative distance along the line in 3D using x, y, and z.

  • channels (ints, optional) – Indices of the channels to plot. All are plotted if None * If system is None, 0 <= channel < self.nChannels else 0 <= channel < self.nChannelsPerSystem[system]

  • system (int, optional) – The system to obtain the channel from.

  • noLegend (bool) – Do not attach a legend to the plot. Default is False, a legend is attached.

Returns:

  • ax (matplotlib.axes) – Plot axes handle

  • legend (matplotlib.legend.Legend) – The attached legend.

See also

geobipy.plotting.plot

For additional keyword arguments

property predicted_primary_field

The data.

property predicted_secondary_field

The data.

property primary_field

The data.

classmethod read_csv(data_filename, system)

Reads the data and system parameters from file

Parameters:

  • dataFilename (str or list of str) – Time domain data file names

  • systemFilename (str or list of str) – Time domain system file names

Notes

File Format

The data columns are read in according to the column names in the first line. The header line should contain at least the following column names. Extra columns may exist, but will be ignored. In this description, the column name or its alternatives are given followed by what the name represents. Optional columns are also described.

Required columns

line

Line number for the data point

id or fid

Id number of the data point, these be unique

x or northing or n

Northing co-ordinate of the data point

y or easting or e

Easting co-ordinate of the data point

z or dtm or dem_elev or dem_np or topo

Elevation of the ground at the data point

alt or laser or bheight

Altitude of the transmitter coil

Off[0] to Off[nWindows-1] (with the number and brackets)

The measurements for each time specified in the accompanying system file under Receiver Window Times

Optional columns

If any loop orientation columns are omitted the loop is assumed to be horizontal.

TxPitch

Pitch of the transmitter loop

TxRoll

Roll of the transmitter loop

TxYaw

Yaw of the transmitter loop

RxPitch

Pitch of the receiver loop

RxRoll

Roll of the receiver loop

RxYaw

Yaw of the receiver loop

OffErr[0] to ErrOff[nWindows-1]

Error estimates for the data

See also

INFORMATION

property secondary_field

The data.

single

alias of TdemDataPoint

property std

The data.

property summary

Display a summary of the Data

writeHdf(parent, name, withPosterior=True)

Write the StatArray to an HDF object parent: Upper hdf file or group myName: object hdf name. Assumes createHdf has already been called create: optionally create the data set as well before writing