Dipole#
- class emg3d.electrodes.Dipole(coordinates, length=1.0)[source]#
Bases:
Wire
A dipole consists of two electrodes in a straight line.
A
Dipole
is a special case of aWire
that consists of exactly two electrodes. A dipole has therefore an azimuth and an elevation. It corresponds to one segment in a wire.Note
Use any of the Tx*/Rx* classes to create sources and receivers, not this class.
- Parameters
- coordinatesarray_like
Dipole coordinates. Three formats are accepted:
[[x1, y1, z1], [x2, y2, z2]];
(x1, x2, y1, y2, z1, z2);
(x, y, z, azimuth, elevation); this format takes also the
length
parameter.
- lengthfloat, default: 1.0
Length of the dipole (m). This parameter is only used if the provided coordinates are in the format (x, y, z, azimuth, elevation).
Attributes Summary
Anticlockwise rotation (°) from x-axis towards y-axis.
Anticlockwise (upwards) rotation (°) from the xy-plane.
Attributes Documentation
- azimuth#
Anticlockwise rotation (°) from x-axis towards y-axis.
- elevation#
Anticlockwise (upwards) rotation (°) from the xy-plane.