xptycho

Ptychographic reconstruction with PMACE in PyTorch.

View on GitHub Full Documentation

Table of Contents

  1. Overview
    1. Key Features
  2. Installation
    1. Quick install on PyPI via
  3. Quick Start
  4. Related Repositories
  5. Citation
  6. License

Overview

xptycho: ptychographic reconstruction with projected multi-agent consensus equilibrium (PMACE) using PyTorch.

Key Features

  • Reconstruction of the complex object image, magnitude and phase, from far-field diffraction frames.
  • Estimation of the probe together with the object, with one or more probe modes.
  • Refinement of the probe positions.
  • Preprocessing of raw detector frames: dark subtraction, outlier removal, centering, and cropping.
  • One HDF5 file format for scans, samples, and reconstructions.
  • Demos on simulated data and on measured data, from raw file to image.
  • Seamless operation on 1 or more GPUs, Mac MPS, or CPU.

Installation

Quick install on PyPI via 

pip install xptycho

Quick Start

Reconstruct in a few lines:

import xptycho as xpt
scan = xpt.Scan.load('scan.h5')
model = xpt.PtychoModel.from_scan(scan)
recon = model.recon(scan)
xpt.view_sample(recon)
Repo Description
mbirjax_applications CT application demos (NSI cone-beam, view selection)
svmbir Parallel and fan-beam CT reconstruction (CPU-optimized)
mbircone Cone-beam CT reconstruction
OpenMBIR-Index Index of all OpenMBIR packages

Citation

xptycho implements the PMACE method of Qiuchen Zhai, Gregery T. Buzzard, Kevin Mertes, Brendt Wohlberg, and Charles A. Bouman. For the papers to cite, the source of the demo data, and the funding support, see Credits

License

BSD 3-Clause License — see LICENSE on GitHub.