SCOPE-XR Documentation

SCOPE-XR (Single-image Characterization Of PErformance in X-Ray systems) is a specialized Python framework for the automated characterization of X-ray systems. The source code is hosted on GitHub.

By analyzing a single acquisition of a circular aperture or disk test object, the software reconstructs 2D source distributions (Focal Spot) and detector response (PSF).

Key Features

• Focal Spot Analysis: Automated 2D reconstruction of focal spot dimensions.

• PSF Estimation: 2D detector Point Spread Function analysis with sub-pixel oversampling.

• Dual Interface: Interactive GUI for routine analysis and CLI for batch research pipelines.

User Guide

• Installation
  • Prerequisites
  • 1. Quick Install (For regular users)
  • 2. Manual Install (From source)
• Quickstart Guide
  • Prerequisites
  • Your First Focal Spot Analysis
  • Your First PSF Analysis
  • CLI Quick Reference
  • Common First-Time Issues
  • Next Steps
• Usage
  • Supported Image Formats
  • GUI Execution
  • CLI Execution
• Troubleshooting
  • Installation Issues
  • Image Loading Issues
  • Circle Detection Problems
  • Reconstruction Quality Issues
  • Performance Issues
  • GUI Issues
  • Output Files Issues
  • Error Messages
  • Getting Help

Methodology

• Physical Methodology
  • Focal Spot Analysis
  • Detector PSF Analysis
• Processing Pipeline
  • 1. Input & Detection
  • 2. Geometric Validation
  • 3. Profile Extraction
  • 4. FBP Reconstruction
  • 5. Measurement & Fitting

API Reference

• scopexr
  • scopexr package

Additional Resources

• Contributing Guidelines

Indices and tables

• Index

• Module Index

• Search Page