API Reference

This page provides complete documentation for all public classes and functions in CDIutils.

Overview

CDIutils is organised into several key modules:

Module	Description
Geometry Module	Beamline geometry and coordinate systems
Converter Module	Coordinate transformations between frames
Pipeline Module	Automated processing workflows
Processing Module	Phase retrieval and post-processing
I/O Module	Data loading and file I/O
Plotting Module	Visualisation and plotting tools
Analysis Module	Statistical analysis utilities
Interactive Module	Interactive 3D visualisation
Wavefront Module	Wavefront propagation and probe analysis
Simulation Module	Data simulation tools

Core Classes

Essential classes for BCDI workflows:

Class	Description
Geometry	Beamline geometry, sample orientation, coordinate conventions
SpaceConverter	Detector ↔ reciprocal ↔ direct space transformations
BcdiPipeline	Complete BCDI pipeline (preprocessing → phasing → postprocessing)
PyNXPhaser	PyNX phase retrieval wrapper with result analysis
PostProcessor	Strain, displacement, phase manipulation tools

Data I/O Classes

Loading data from different beamlines:

Class	Description
Loader	Base loader class with factory method
ID01Loader	ESRF ID01 beamline (BLISS format)
P10Loader	PETRA III P10 beamline
SIXSLoader	SOLEIL SIXS beamline
NanoMaxLoader	MAX IV NanoMAX beamline
CXIFile	CXI file format reader/writer
CXIExplorer	Interactive CXI file explorer widget

Interactive Visualisation

3D interactive tools:

Class/Function	Description
VolumeViewer (3D Interactive)	Advanced 3D isosurface viewer with full controls
VolumeViewer	Interactive 2D slice viewer widget
Plotting Functions	Quick 3D visualisation function

Class Reference

Detailed documentation by class:

Core Classes

• Geometry
• SpaceConverter
• BcdiPipeline
• Pipeline
• PyNXPhaser
• PostProcessor
• PhasingResultAnalyser

I/O Classes

• Loader
• ID01Loader
• P10Loader
• SIXSLoader
• NanoMaxLoader
• CXIFile
• CXIExplorer

Interactive Classes

• VolumeViewer (3D Interactive)
• VolumeViewer

Function Reference

Key functions organised by category:

By Category

• Plotting Functions
• Utility Functions
• Analysis Functions
• I/O Functions

Module Reference

Detailed documentation by module:

By Module

• Geometry Module
• Converter Module
• Pipeline Module
• Processing Module
• I/O Module
• Plotting Module
• Analysis Module
• Interactive Module
• Wavefront Module
• Simulation Module
• Utilities Module

Quick Links

Most Common Use Cases:

• Loading data: Loader, ID01Loader

• Coordinate transformations: SpaceConverter

• Full pipeline: BcdiPipeline

• Phase retrieval: PyNXPhaser

• Post-processing: PostProcessor

• 3D visualisation: VolumeViewer (3D Interactive), Plotting Functions

• Plotting slices: Plotting Functions

Search

Use the search box in the sidebar to quickly find specific classes, functions, or parameters.