EmLoop

digraph inheritancef4d5cd9044 { 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"]; "EmLoop" [URL="#geobipy.src.classes.system.EmLoop.EmLoop",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="Defines a loop in an EM system e.g. transmitter or reciever"]; "Point" -> "EmLoop" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ABC" -> "EmLoop" [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)"]; }

class geobipy.src.classes.system.EmLoop.EmLoop(x=None, y=None, z=None, elevation=None, orientation=None, moment=None, pitch=None, roll=None, yaw=None, **kwargs)

Defines a loop in an EM system e.g. transmitter or reciever

This is an abstract base class and should not be instantiated

EmLoop()

append(other)

Append pointclouds together

Parameters:

other (geobipy.PointCloud3D) – 3D pointcloud

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

classmethod fromHdf(grp, index=None)

Reads in the object from a HDF file

perturb()

Propose a new point given the attached propsal distributions

property probability

Evaluate the probability for the EM data point given the specified attached priors

Parameters:

• rEerr (bool) – Include the relative error when evaluating the prior

• aEerr (bool) – Include the additive error when evaluating the prior

• height (bool) – Include the elevation when evaluating the prior

• calibration (bool) – Include the calibration parameters when evaluating the prior

• verbose (bool) – Return the components of the probability, i.e. the individually evaluated priors

Returns:

out – The evaluation of the probability using all assigned priors

Return type:

float64

Notes

For each boolean, the associated prior must have been set.

Raises:

TypeError – If a prior has not been set on a requested parameter

set_pitch_posterior()

set_roll_posterior()

set_yaw_posterior()

property summary

Print a summary

writeHdf(parent, name, withPosterior=True, index=None)

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