mmt_multipole_inversion.magnetic_sample_modules.spherical_harmonics_basis#

Module Contents#

Functions#

dipole_Bz(dip_r, dip_m, pos_r, Bz_grid, Sx_range, Sy_range)

Compute the z-component of the dipole field at the pos_r position(s), from

quadrupole_Bz(quad_r, quad_m, pos_r, Bz_grid, Sx_range, Sy_range)

Compute the z-component of the field of a point quadrupole at the pos_r

octupole_Bz(oct_r, oct_m, pos_r, Bz_grid, Sx_range, Sy_range)

Compute the z-component of the field of a point octupole at the pos_r

mmt_multipole_inversion.magnetic_sample_modules.spherical_harmonics_basis.dipole_Bz(dip_r, dip_m, pos_r, Bz_grid, Sx_range, Sy_range)#

Compute the z-component of the dipole field at the pos_r position(s), from a group of particles located at the dip_r dipole_positions, and which have magnetic dipole moments given in the dip_m array.

For these arrays, N > 1

dip_r :: N x 3 array with dipole positions (m) dip_m :: N x 3 array with dipole moments (Am^2) pos_r :: 1 x 3 array with coordinates of measurement point (m)

Returns

N x 3 array :: Rows are Bz generated by each particle

mmt_multipole_inversion.magnetic_sample_modules.spherical_harmonics_basis.quadrupole_Bz(quad_r, quad_m, pos_r, Bz_grid, Sx_range, Sy_range)#

Compute the z-component of the field of a point quadrupole at the pos_r position(s), from a group of particles located at the quad_r quadrupole positions, and which have magnetic quadrupole moments given in the quad_m array.

For these arrays, N > 1

quad_r :: N x 3 array with point quadrupole positions (m) quad_m :: N x 3 array with quadrupole moments (A m^2) pos_r :: 1 x 3 array (m)

Returns

N x 3 array

mmt_multipole_inversion.magnetic_sample_modules.spherical_harmonics_basis.octupole_Bz(oct_r, oct_m, pos_r, Bz_grid, Sx_range, Sy_range)#

Compute the z-component of the field of a point octupole at the pos_r position(s), from a group of particles located at the oct_r octupole positions, and which have magnetic octupole moments given in the oct_m array.

For these arrays, N > 1

oct_r :: N x 3 array with point octupole positions (m) oct_m :: N x 3 array with octupole moments (A m^3) pos_r :: N x 3 array OR 1 x 3 array (m)

Returns

N x 3 array