FdemDataPoint

digraph inheritance205783337d { 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"]; "DataPoint" [URL="datapoint.html#geobipy.src.classes.data.datapoint.DataPoint.DataPoint",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 defines a data point."]; "Point" -> "DataPoint" [arrowsize=0.5,style="setlinewidth(0.5)"]; "EmDataPoint" [URL="EmDataPoint.html#geobipy.src.classes.data.datapoint.EmDataPoint.EmDataPoint",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="Abstract EmDataPoint Class"]; "DataPoint" -> "EmDataPoint" [arrowsize=0.5,style="setlinewidth(0.5)"]; "FdemDataPoint" [URL="#geobipy.src.classes.data.datapoint.FdemDataPoint.FdemDataPoint",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 defines a Frequency domain electromagnetic data point."]; "EmDataPoint" -> "FdemDataPoint" [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)"]; "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)"]; }

@FdemDataPoint_Class Module describing a frequency domain EMData Point that contains a single measurement.

class geobipy.src.classes.data.datapoint.FdemDataPoint.FdemDataPoint(x=0.0, y=0.0, z=0.0, elevation=0.0, data=None, std=None, predictedData=None, system=None, lineNumber=0.0, fiducial=0.0)

Class defines a Frequency domain electromagnetic data point.

Contains an easting, northing, height, elevation, observed and predicted data, and uncertainty estimates for the data.

FdemDataPoint(x, y, z, elevation, data, std, system, lineNumber, fiducial)

Parameters:

x (float) – Easting co-ordinate of the data point
y (float) – Northing co-ordinate of the data point
z (float) – Height above ground of the data point
elevation (float, optional) – Elevation from sea level of the data point
data (geobipy.StatArray or array_like, optional) – Data values to assign the data of length 2*number of frequencies. * If None, initialized with zeros.
std (geobipy.StatArray or array_like, optional) – Estimated uncertainty standard deviation of the data of length 2*number of frequencies. * If None, initialized with ones if data is None, else 0.1*data values.
system (str or geobipy.FdemSystem, optional) – Describes the acquisition system with loop orientation and frequencies. * If str should be the path to a system file to read in. * If geobipy.FdemSystem, will be deepcopied.
lineNumber (float, optional) – The line number associated with the datapoint
fiducial (float, optional) – The fiducial associated with the datapoint

calibrate(Predicted=True): Apply calibration factors to the data point

createHdf(parent, name, withPosterior=True, add_axis=None, fillvalue=None): Create the hdf group metadata in file parent: HDF object to create a group inside myName: Name of the group

forward(mod): Forward model the data from the given model

frequencies(system=0): Return the frequencies in an StatArray

classmethod fromHdf(grp, index=None, **kwargs): Reads the object from a HDF group

getFrequency(channel, system=0)

Return the measurement frequency of the channel

Parameters:

channel (int) – Channel number
system (int, optional) – System number

Returns:

out – The measurement frequency of the channel

Return type:

float

getMeasurementType(channel, system=0)

Returns the measurement type of the channel

Parameters:

channel (int) – Channel number
system (int, optional) – System number

Returns:

out – Either “In-Phase “ or “Quadrature “

Return type:

str

plot(title='Frequency Domain EM Data', system=0, with_error_bars=True, **kwargs)

Plot the Inphase and Quadrature Data

Parameters:

title (str) – Title of the plot
system (int) – If multiple system are present, select which one
with_error_bars (bool) – Plot vertical lines representing 1 standard deviation