Package API

This page lists main classes in this package.

Calculator API

Calculator classes.

SourceCalculators

X-ray source calculators

SourceCalculators.GaussianSourceCalculator(name)	Class calculating a x-ray free electron laser photon source under the gaussian assumption.
SourceCalculators.PhenomSourceCalculator(name)	Class calculating a x-ray free electron laser photon source under the gaussian assumption.

PropagationCalculators

Wave propagation calculators

PropagationCalculators.WPGPropagationCalculator(...)

Class representing photon propagation through X-ray optics.

PMICalculators

Photon-matter-interaction calculators

PMICalculators.SimpleScatteringPMICalculator(...)

Class representing simple elastic scattering process.

DiffractionCalculators

X-ray diffraction calculators

DiffractionCalculators.SingFELDiffractionCalculator(...)	Diffraction pattern calculator with pysingfel backend.
DiffractionCalculators.CrystfelDiffractionCalculator(...)	Diffraction pattern calculator with CrystFEL backend.

Data API

Data classes and related DataFormat classes.

SampleData

SampleData.SampleData(key[, data_dict, ...])	Sample structure data mapper
SampleData.ASEFormat()	Class that interfacing data format supported by ASE.

DiffractionData

DiffractionData.DiffractionData(key[, ...])	Diffraction data mapper
DiffractionData.SingFELFormat()	Defines I/O for the SingFEL format.
DiffractionData.EMCFormat()	Defines I/O for the EMC (Dragonfly orientation recovery) format .