geoana.em.BaseDipole#

Inheritance diagram of BaseDipole
class geoana.em.BaseDipole(location=array([0., 0., 0.]), orientation='X', **kwargs)#

Base class for dipoles; namely the location and orientation. This class is inherited by both electric current and magnetic dipoles.

Parameters
location: (3) array_like, optional

Location of the dipole in 3D space. Default is (0,0,0)

orientation(3) array_like or {‘X’,’Y’,’Z’}

Orientation of the dipole. Can be defined using as an array_like of length 3, or by using one of {‘X’,’Y’,’Z’} to define a unit dipole along the x, y or z direction. Default is ‘X’.

Attributes

location

Location of the dipole

orientation

Orientation of the dipole as a normalized vector

Methods

cross_orientation(xyz)

Cross products between a gridded set of vectors and the orientation of the source.

distance(xyz)

Scalar distance from dipole to a set of gridded xyz locations

dot_orientation(vecs)

Dot product between the orientation of the source and a gridded set of vectors.

vector_distance(xyz)

Vector distance to a set of gridded xyz locations.

Galleries and Tutorials using geoana.em.BaseDipole#

Magnetostatic Vector Potentials: Dipole and Loop Sources

Magnetostatic Vector Potentials: Dipole and Loop Sources

Magnetostatic Vector Potentials: Dipole and Loop Sources
Total magnetic fields: Dipole and Pole sources

Total magnetic fields: Dipole and Pole sources

Total magnetic fields: Dipole and Pole sources
Electric Dipole in a Whole Space: Frequency Domain

Electric Dipole in a Whole Space: Frequency Domain

Electric Dipole in a Whole Space: Frequency Domain