Tutorials

The following tutorials demonstrate how to use the neutron-geomcorr package for cylindrical geometry correction. All committed notebooks (tutorials and the notebooks/dev_* development series alike) carry executed outputs, so they can be browsed on GitHub without setting up an environment.

Step-by-step series (FITS)

A four-part walkthrough splitting loading and correction into separate notebooks:

• tutorial00 — loading a homogeneous dataset

• tutorial01 — correcting a homogeneous cylinder

• tutorial02 — loading an inhomogeneous (hollow) dataset

• tutorial03 — correcting an inhomogeneous cylinder

Homogeneous Cylinder Tutorial

This tutorial demonstrates the correction process for homogeneous cylindrical samples.

View Tutorial Notebook (Homogeneous)

The tutorial covers:

• Loading TIFF images of homogeneous cylindrical samples

• Setting up geometry parameters (center and radius)

• Applying the homogeneous correction algorithm

• Visualizing the corrected results

Inhomogeneous Cylinder Tutorial

This tutorial demonstrates the correction process for inhomogeneous cylindrical samples with inner and outer radii.

View Tutorial Notebook (Inhomogeneous)

The tutorial covers:

• Loading TIFF images of inhomogeneous cylindrical samples

• Setting up geometry parameters (center, inner radius, outer radius)

• Applying the inhomogeneous correction algorithm

• Visualizing the corrected results

Running the Tutorials

To run these tutorials locally:

1. Clone the repository:

   git clone https://github.com/ornlneutronimaging/CylindricalGeometryCorrection.git
   cd CylindricalGeometryCorrection
   

2. Install the package with pixi:

   pixi install
   pixi shell
   

3. Launch Jupyter and open the tutorial notebooks:

   jupyter lab notebooks/