Metadata-Version: 2.4
Name: magtomo
Version: 0.1.1
Summary: ------------
Author: Andreas Apseros
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/apseros/magpack
Project-URL: Issues, https://github.com/apseros/magpack/issues
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: pyevtk
Requires-Dist: matplotlib
Requires-Dist: pillow
Requires-Dist: scipy
Requires-Dist: ThreeDViewer
Requires-Dist: magpack
Dynamic: license-file

magtomo
=======
magtomo is a python package for performing scalar, vector and orientation tomography.

Installation
------------
magtomo can be installed through pip:

.. code-block:: console

   (.venv)$ pip install magtomo

Examples
--------
Examples of scalar, vector and orientation reconstructions can be found in the magtomo.examples() module. To simulate
the process, projections are first calculated

.. code-block:: python

    # scalar structure projections
    projections = radon(struct, angles)
    # vector or orientation field projections
    exp = Experiment(magnetization=struct, rotations=rot, pol=pol)
    exp.calculate_sinogram()
    projections = exp.sinogram

the projections are then used as input for the reconstruction process

.. code-block:: python

    # inverse of scalar projections
    recons = inv_radon(projections, angles)
    # reconstruction from vector or orientation projections
    rec = Reconstruction(initial_guess, rotations=rot, projections=projections,
                         pol=pol, mask=mask)
    rec.reconstruct()
    recons = rec.magnetization


Documentation
-------------
Comprehensive documentation is available online at `readthedocs <https://magtomo.readthedocs.io/en/latest>`_.
