magdataframe

packaged authored and maintained by SB Quantum

Full documentation published on ReadTheDocs

magdataframe (magdf) is a package centered around the MagDataFrame (MDF), an extension of the Pandas DataFrame class that adds methods and functionality facilitating the treatment and visualization of Full Magnetic Tensor Gradiometry (FMTG) data.

At its core, the MDF is a Pandas DataFrame with additional structure and methods pertaining to FMTG data. The columns of the DataFrame are divided in categories:

• Positions (pos) : [x, y, z]
• Time (time) : [t]
• Magnetic fields (fields) : [Bx, By, Bz]
• Magnetic field gradients (grads) : [Bxx, Bxy, Bxz, Byx, Byy, Byz, Bzx, Bzy, Bzz]
• Magnetic field uncertainties (sfields) : [sBx, sBy, sBz]
• Magnetic field gradient uncertainties (sgrads) : [sBxx, sBxy, ... , sBzz]
• Extra (extra) : everything else

This classification creates a basis used by the operations and methods developed in the package to enable easy handling of FMTG data.