harmonica.Sphere

class harmonica.Sphere(a, center, *, density=None, susceptibility=None, remanent_mag=None)

Homogeneous sphere.

Represent a sphere as a particular type of ellipsoid where a == b == c.

Parameters:

afloat

Radius or semiaxes lengths in meters.

centertuple of float

Coordinates of the center of the sphere in the following order: easting, northing, upward. All must be in meters.

densityfloat or None, optional

Density of the sphere in \(kg/m^3\).

susceptibilityfloat, (3, 3) array or None, optional

Magnetic susceptibility of the sphere in SI units. A single float represents isotropic susceptibility in the body. A (3, 3) array represents the susceptibility tensor to account for anisotropy. If None, zero susceptibility will be assigned to the sphere.

remanent_mag(3,) array or None, optional

Remanent magnetization vector of the sphere in A/m units. Its components are defined in the easting-northing-upward coordinate system and should be passed in that order. If None, no remanent magnetization will be assigned to the sphere.

Notes

All semiaxes (a, b and c) are equal to each other. All rotation angles (yaw, pitch and roll) are equal to zero for the sphere, since sphere is invariant to rotations.

Attributes:

a

Length of the first semiaxis.

b

Length of the second semiaxis.

c

Length of the third semiaxis.

density

Density of the ellipsoid in \(kg/m^3\).

pitch

Pitch angle, equal to zero.

radius

Sphere radius.

remanent_mag

Remanent magnetization of the ellipsoid in A/m.

roll

Roll angle, equal to zero.

rotation_matrix

Create a rotation matrix for the sphere.

susceptibility

Magnetic susceptibility of the ellipsoid in SI units.

yaw

Yaw angle, equal to zero.

Attributes

Sphere.a

Length of the first semiaxis.

Sphere.b

Length of the second semiaxis.

Sphere.c

Length of the third semiaxis.

Sphere.density

Density of the ellipsoid in \(kg/m^3\).

Sphere.pitch

Pitch angle, equal to zero.

Sphere.radius

Sphere radius.

Sphere.remanent_mag

Remanent magnetization of the ellipsoid in A/m.

Sphere.roll

Roll angle, equal to zero.

Sphere.rotation_matrix

Create a rotation matrix for the sphere.

Returns:

rotation_matrix(3, 3) array

Identity matrix.

Sphere.susceptibility

Magnetic susceptibility of the ellipsoid in SI units.

Sphere.yaw

Yaw angle, equal to zero.

---