Skip to main content

Pilatus detector image synthesizer for SAXS beamlines

Project description

Pilatus Synthesizer

Pilatus Synthesizer combines multiple Pilatus X-ray detector images taken at different detector positions into a single synthesized image. Used at KEK Photon Factory and SPring-8 beamlines for SAXS experiments.

Features

  • Sub-pixel alignment: Bilinear interpolation for accurate image registration
  • Mask handling: SAngler mask file support for excluding bad pixels
  • Intensity normalization: Beam monitor counter-based intensity correction
  • Multiple synthesis methods: Cover (gap-filling) and average modes
  • GUI and CLI: Interactive Tkinter interface or batch command-line processing
  • Auto-run: Folder polling for automated synthesis during measurements
  • Facility support: Photon Factory (left direction) and SPring-8 (right direction)

Tested Platforms

  • Python 3.13 on Windows 11
  • Python 3.12 on Windows 11

Installation

pip install -U pilatus-synthesizer

Usage

GUI mode (default)

pilatus-synthesizer

Command-line mode

pilatus-synthesizer -c -i INPUT_FOLDER [-o OUTPUT_FOLDER]

Options

Flag Description
-c Run in command mode (no GUI)
-i FOLDER Input image folder (required for command mode)
-o FOLDER Output folder (default: INPUT/Synthesized)
-n Auto-number output folders if default exists
-j FOLDER Adjusted image folder
-m Write intermediate results
-v Show version info

Documentation

Related Projects

License

GNU General Public License v3.0

Copyright

Copyright (c) 2015-2026, SAXS Team, KEK-PF

Acknowledgements

The migration of this project from the legacy codebase to the current Python package structure was performed with the assistance of GitHub Copilot (Claude Sonnet 4.6), 2026.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pilatus_synthesizer-0.5.1.tar.gz (2.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pilatus_synthesizer-0.5.1-py3-none-any.whl (88.5 kB view details)

Uploaded Python 3

File details

Details for the file pilatus_synthesizer-0.5.1.tar.gz.

File metadata

  • Download URL: pilatus_synthesizer-0.5.1.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pilatus_synthesizer-0.5.1.tar.gz
Algorithm Hash digest
SHA256 843c2704b26cc9c6b928cd60c74536a0b5fed97c8b89f9fc2908d7d817676602
MD5 3c419ab9c71b7d7cd1a4e70fe910cbc0
BLAKE2b-256 8f48c6d6f0d1254f9695c939b7f50e35acb68bc6256deaf217bc9c355400247f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pilatus_synthesizer-0.5.1.tar.gz:

Publisher: upload_to_pypi.yml on biosaxs-dev/pilatus-synthesizer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pilatus_synthesizer-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pilatus_synthesizer-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2b687448e88d8e30e57cbdec839e42b0e326ecc31249bbc1f7d4056218bf0af8
MD5 433c6238bc5c02e27482b02df1c9cd2f
BLAKE2b-256 5678f672806ffa03dc56fefadcb9257becbb9abc4c4b0847fda13d763d3caca3

See more details on using hashes here.

Provenance

The following attestation bundles were made for pilatus_synthesizer-0.5.1-py3-none-any.whl:

Publisher: upload_to_pypi.yml on biosaxs-dev/pilatus-synthesizer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page