TempestData
digraph inheritance92a4e4a9a8 { 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="TdemData.html#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)"]; "TempestData" [URL="#geobipy.src.classes.data.dataset.TempestData.TempestData",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"]; "TdemData" -> "TempestData" [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.TempestData.TempestData(*args, **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], nSxfystems=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:
See also
read()
For information on file format
- property additive_error
The data.
- 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
- classmethod fromHdf(grp, **kwargs)
Reads the object from a HDF group
- plot_data(system=0, channels=None, x='index', **kwargs)
Plots the data
- Parameters:
system (int) – System to plot
channels (sequence of ints) – Channels to plot
- plot_predicted(system=0, channels=None, xAxis='index', **kwargs)
Plots the data
- Parameters:
system (int) – System to plot
channels (sequence of ints) – Channels to plot
- classmethod read_csv(data_filename, system_filename)
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
- classmethod read_netcdf(dataFilename, systemFilename, indices=None)
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 relative_error
The data.
- single
alias of
Tempest_datapoint
- 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