API Reference

• xpcsviewer package
  • Main Package
  • Core Classes
  • XpcsFile Submodules
  • Package Information
• Backends
  • Overview
  • Quick Start
  • Backend Functions
  • Backend Protocol
  • Array Conversions
  • I/O Adapters
  • Device Management
  • SciPy Replacements
  • See Also
• Schemas
  • Overview
  • Quick Start
  • Schema Classes
  • Immutability
  • Validators
  • See Also
• I/O Facade
  • Overview
  • Quick Start
  • HDF5Facade
  • HDF5ValidationError
  • Writing Data
  • Connection Pool
  • See Also
• Fitting Module
  • Overview
  • Quick Start
  • Public API
  • NLSQ 0.6.0 Features
  • Models
  • Legacy Functions
  • Bayesian Assembly
  • See Also
• Analysis Modules
  • G2 Correlation Analysis
  • SAXS 1D Analysis
  • SAXS 2D Visualization
  • Two-Time Correlation
  • Stability Analysis
  • Intensity vs Time
  • Tau-Q Analysis
  • File Averaging
• SimpleMask
  • Module Overview
  • SimpleMaskWindow
  • SimpleMaskKernel
  • Q-Map Module
  • Area Mask Module
  • Drawing Tools Module
  • Utils Module
  • PyQtGraph Modifications
  • Calibration Module
• File I/O
  • HDF5 Reader
  • Enhanced HDF5 Reader
  • Q-space Mapping
  • APS 8-IDI Beamline Support
  • File Type Utilities
• Command-Line Interface
  • Entry Points
  • Available Commands
  • Utility Functions
• Plotting
  • PyQtGraph Handler
  • Matplotlib Integration
  • Plot Constants
  • Qt Signal Fixes
• Threading
  • Async Workers
  • Async Kernel
  • Plot Workers
  • GUI Integration
  • Unified Threading
  • Cleanup Optimization
  • Progress Management
  • Bayesian Fit Worker
  • Batch Bayesian Coordinator
• Utilities
  • Logging Configuration
  • Logging Utilities
  • Log Formatters
  • Memory Management
  • Performance Monitoring
  • Reliability
  • Validation
  • Exceptions
  • Common Checks
  • Data Processing
  • Atomic I/O
  • Device Detection
  • Health Monitoring
  • Memory Prediction
  • Reliability Manager
  • Startup Optimization
  • State Validation
  • Visualization Optimization
  • See Also
• Constants
  • Overview
  • Usage
  • Submodules
• GUI Components
  • Main Application
  • Viewer Kernel
  • File Locator
  • Default Settings
  • Command Line Interface
  • GUI Modernization Components
• Helper Utilities
  • List Data Model
  • Logger Writer
  • Utility Functions

Core Components

• XpcsFile: Data container and analysis (xpcsviewer package)

• Backends: JAX/NumPy abstraction with device management (Backends)

• Schemas: Type-safe validated data structures (Schemas)

• I/O Facade: HDF5 operations with schema validation (I/O Facade)

• Fitting: Bayesian fitting with NLSQ warm-start (Fitting Module)

• Analysis Modules: G2, SAXS, two-time, stability (Analysis Modules)

• SimpleMask: Mask editing and Q-map generation (SimpleMask)

• File I/O: Low-level HDF5 reading and Q-space mapping (File I/O)

• CLI: Command-line interface for batch processing (Command-Line Interface)

• Plotting: PyQtGraph and Matplotlib integration (Plotting)

• Threading: Asynchronous workers and progress management (Threading)

• Constants: Application-wide configuration values (Constants)

• GUI: PySide6 interactive visualization (GUI Components)

• Utils: Logging, memory management, optimization (Utilities)

• Helper: Internal data models and utilities (Helper Utilities)