List of functions and classes (API)

List of functions and classes (API)#

Kernel and forward modelling functions#

Here you will find the list of available kernel and forward modelling functions for gravity and magnetic fields generated by different type of sources.

Point sources and dipoles#

For point sources, dipoles and observation points defined in Cartesian coordinates.

Gravity#

point.gravity_pot(easting_p, northing_p, ...)

Gravitational potential field due to a point source

point.gravity_e(easting_p, northing_p, ...)

Easting component of the gravitational acceleration due to a point source

point.gravity_n(easting_p, northing_p, ...)

Northing component of the gravitational acceleration due to a point source

point.gravity_u(easting_p, northing_p, ...)

Upward component of the gravitational acceleration due to a point source

point.gravity_ee(easting_p, northing_p, ...)

Easting-easting component of the gravitational tensor due to a point source

point.gravity_nn(easting_p, northing_p, ...)

Northing-northing component of the gravitational tensor due to point source

point.gravity_uu(easting_p, northing_p, ...)

Upward-upward component of the gravitational tensor due to a point source

point.gravity_en(easting_p, northing_p, ...)

Easting-northing component of the gravitational tensor due to point source

point.gravity_eu(easting_p, northing_p, ...)

Easting-upward component of the gravitational tensor due to point source

point.gravity_nu(easting_p, northing_p, ...)

Northing-upward component of the gravitational tensor due to point source

Magnetic#

dipole.magnetic_e(easting_p, northing_p, ...)

Easting component of the magnetic field due to a dipole

dipole.magnetic_n(easting_p, northing_p, ...)

Northing component of the magnetic field due to a dipole

dipole.magnetic_u(easting_p, northing_p, ...)

Upward component of the magnetic field due to a dipole

dipole.magnetic_field(easting_p, northing_p, ...)

Magnetic field due to a dipole

Kernels#

point.kernel_pot(easting_p, northing_p, ...)

The inverse of the distance between the two points

point.kernel_e(easting_p, northing_p, ...)

Easting component of the gradient of the inverse of the distance

point.kernel_n(easting_p, northing_p, ...)

Northing component of the gradient of the inverse of the distance

point.kernel_u(easting_p, northing_p, ...)

Upward component of the gradient of the inverse of the distance

point.kernel_ee(easting_p, northing_p, ...)

Second derivative of the inverse of the distance along easting-easting

point.kernel_nn(easting_p, northing_p, ...)

Second derivative of the inverse of the distance along northing-northing

point.kernel_uu(easting_p, northing_p, ...)

Second derivative of the inverse of the distance along upward-upward

point.kernel_en(easting_p, northing_p, ...)

Second derivative of the inverse of the distance along easting-northing

point.kernel_eu(easting_p, northing_p, ...)

Second derivative of the inverse of the distance along easting-upward

point.kernel_nu(easting_p, northing_p, ...)

Second derivative of the inverse of the distance along northing-upward

Rectangular Prisms#

Gravity#

prism.gravity_pot(easting, northing, upward, ...)

Gravitational potential field due to a rectangular prism

prism.gravity_e(easting, northing, upward, ...)

Easting component of the gravitational acceleration due to a prism

prism.gravity_n(easting, northing, upward, ...)

Northing component of the gravitational acceleration due to a prism

prism.gravity_u(easting, northing, upward, ...)

Upward component of the gravitational acceleration due to a prism

prism.gravity_ee(easting, northing, upward, ...)

Easting-easting component of the gravitational tensor due to a prism

prism.gravity_nn(easting, northing, upward, ...)

Northing-northing component of the gravitational tensor due to a prism

prism.gravity_uu(easting, northing, upward, ...)

Upward-upward component of the gravitational tensor due to a prism

prism.gravity_en(easting, northing, upward, ...)

Easting-northing component of the gravitational tensor due to a prism

prism.gravity_eu(easting, northing, upward, ...)

Easting-upward component of the gravitational tensor due to a prism

prism.gravity_nu(easting, northing, upward, ...)

Northing-upward component of the gravitational tensor due to a prism

Magnetic#

prism.magnetic_field(easting, northing, ...)

Magnetic field due to a rectangular prism

prism.magnetic_e(easting, northing, upward, ...)

Easting component of the magnetic field due to a prism

prism.magnetic_n(easting, northing, upward, ...)

Northing component of the magnetic field due to a prism

prism.magnetic_u(easting, northing, upward, ...)

Upward component of the magnetic field due to a prism

prism.magnetic_ee(easting, northing, upward, ...)

Easting derivative of the easting component of the magnetic field.

prism.magnetic_nn(easting, northing, upward, ...)

Northing derivative of the northing component of the magnetic field.

prism.magnetic_uu(easting, northing, upward, ...)

Upward derivative of the upward component of the magnetic field.

prism.magnetic_en(easting, northing, upward, ...)

Northing derivative of the easting component of the magnetic field.

prism.magnetic_eu(easting, northing, upward, ...)

Upward derivative of the easting component of the magnetic field.

prism.magnetic_nu(easting, northing, upward, ...)

Upward derivative of the northing component of the magnetic field.

Kernels#

prism.kernel_pot(easting, northing, upward, ...)

Kernel for the potential field due to a rectangular prism

prism.kernel_e(easting, northing, upward, radius)

Kernel for easting component of the gradient due to a rectangular prism

prism.kernel_n(easting, northing, upward, radius)

Kernel for northing component of the gradient due to a rectangular prism

prism.kernel_u(easting, northing, upward, radius)

Kernel for upward component of the gradient due to a rectangular prism

prism.kernel_ee(easting, northing, upward, ...)

Kernel for easting-easting component of the tensor due to a prism

prism.kernel_nn(easting, northing, upward, ...)

Kernel for northing-northing component of the tensor due to a prism

prism.kernel_uu(easting, northing, upward, ...)

Kernel for upward-upward component of the tensor due to a prism

prism.kernel_en(easting, northing, upward, ...)

Kernel for easting-northing component of the tensor due to a prism

prism.kernel_eu(easting, northing, upward, ...)

Kernel for easting-upward component of the tensor due to a prism

prism.kernel_nu(easting, northing, upward, ...)

Kernel for northing-upward component of the tensor due to a prism

prism.kernel_eee(easting, northing, upward, ...)

Easting-easting-easting kernel due to a prism.

prism.kernel_nnn(easting, northing, upward, ...)

Northing-northing-northing kernel due to a prism.

prism.kernel_uuu(easting, northing, upward, ...)

Upward-upward-upward kernel due to a prism.

prism.kernel_een(easting, northing, upward, ...)

Easting-easting-northing kernel due to a prism.

prism.kernel_eeu(easting, northing, upward, ...)

Easting-easting-upward kernel due to a prism.

prism.kernel_enn(easting, northing, upward, ...)

Easting-northing-northing kernel due to a prism.

prism.kernel_nnu(easting, northing, upward, ...)

Northing-northing-upward kernel due to a prism.

prism.kernel_euu(easting, northing, upward, ...)

Easting-upward-upward kernel due to a prism.

prism.kernel_nuu(easting, northing, upward, ...)

Northing-upward-upward kernel due to a prism.

prism.kernel_enu(easting, northing, upward, ...)

Easting-northing-upward kernel due to a prism.

Utilities#

Euclidean distances#

Use these functions to compute Euclidean distance in Cartesian and spherical coordinates:

utils.distance_cartesian(easting_p, ...)

Euclidean distance between two points given in Cartesian coordinates

utils.distance_spherical(longitude_p, ...)

Euclidean distance between two points in spherical coordinates

utils.distance_spherical_core(longitude_p, ...)

Core computation of distance between two points in spherical coordinates

Universal Constants#

Access universal physical constants given in SI units:

constants.GRAVITATIONAL_CONST

Gravitational constant \(G\) in SI units (\(m^3 kg^{-1} s^{-2}\))

constants.VACUUM_MAGNETIC_PERMEABILITY

Vacuum magnetic permeability \(\mu_0\) in SI units (\(NA^{-2}\))