axitom 0.1.3

<!– PROJECT SHIELDS –>

[](https://circleci.com/gh/PolymerGuy/AXITOM) [](https://codecov.io/gh/PolymerGuy/AXITOM) [![MIT License][license-shield]][license-url] [](https://axitom.readthedocs.io/en/latest/?badge=latest) [](https://badge.fury.io/py/axitom)

<!– PROJECT LOGO –> <br /> <p align=”center”> <img src=”./docs/logo.png” alt=”Logo” width=”500” height=”500”> </p>

<h3 align=”center”>AXITOM</h3>

<p align=”center”> Tomographic reconstruction of axisymmetric fields acquired by a cone beam <br /> <a href=”https://axitom.readthedocs.io/en/latest/”><strong>Explore the docs </strong></a> <br /> </p>

<!– ABOUT THE PROJECT –> About The Project —————– This python package provides tools for axis-symmetric cone-beam computed tomography. A Feldkamp David Kress algorithm performs the reconstruction which have been adapted such that is exploits the axis-symmetric nature of the tomogram.

This toolkit has a highly specialised usage, and there are plenty of more general and excellent frameworks for tomographic reconstruction, such as:

• [TomoPy](https://github.com/tomopy/tomopy) (General computed tomography, cone and parallel beam geometry)

• [PyAbel](https://github.com/PyAbel/PyAbel) (Computed tomography based on the inverse Abel transform, parallel beam geometry)

This project aims at providing a simple, accessible toolkit for forward-projection and reconstruction of axis-symmetric tomograms based on a conical beam geometry.

### Built With This project is heavily based on the following packages: * [Numpy](https://numpy.org/) * [Scipy](https://www.scipy.org/) * [Scikit-image](https://scikit-image.org/) * [Matplotlib](https://matplotlib.org/)

<!– GETTING STARTED –> Getting Started ————— To get a local copy up and running follow these steps.

### Install via package manager:

The toolkit is available via PIP, and the instructions below shows how a virtual environment can be created and the toolkit installed.

Prerequisites:

This toolkit is tested on Python 3.6 We recommend the use of virtualenv

Installing:

$ virtualenv -p python3.6 env $ source ./env/bin/activate #On Linux and Mac OS $ envScriptsactivate.bat #On Windows $ pip install axitom

Now the toolkit is installed and ready for use.

Run the tests:

$ nosetests axitom

If you want to check out the examples, then download the files in the examples folder and run the examples.

### Clone the repo:

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites:

This toolkit is tested on Python 3.6 We recommend the use of virtualenv

Clone this repo to your preferred location

$ git init $ git clone https://github.com/PolymerGuy/axitom.git

We recommend that you always use virtual environments, either by virtualenv or by Conda env

$ virtualenv -p python3.6 env $ source ./env/bin/activate #On Linux and Mac OS $ envScriptsactivate.bat #On Windows $ pip install -r requirements.txt

You can now run an example:

$ python <path_to_axitom>/examples/comparison_to_Nikon.py

### Run the tests The tests should always be launched to check your installation. These tests are integration and unit tests.

If you cloned the repo, you have to call pytest from within the folder

$ pytest