Package API

This page lists main classes in this package.

crystalpy classes.

diffraction

crystalpy.diffraction classes for diffraction setup and calculations

`diffraction.Diffraction`	Defines a crystal diffraction experiment setup.
`diffraction.DiffractionSetupAbstract`	Represents a diffraction setup abstract class.
`diffraction.DiffractionSetupSweeps`	Represents a diffraction setup (from where it inherits) and includes a photon beam with scanning photon energy and deviation angle (scattering plane is YZ plane)
`diffraction.DiffractionSetupDabax`	Represents a diffraction setup implementation using DABAX photon energy in eV dSpacing returns A units are in SI.
`diffraction.DiffractionSetupXraylib`	Represents a diffraction setup implementation using xraylib photon energy in eV dSpacing returns A units are in SI.
`diffraction.DiffractionSetupShadowPreprocessorV1`	Represents a diffraction setup implementation using material data from shadow bragg preprocessor V1 photon energy in eV dSpacing returns A units are in SI.
`diffraction.DiffractionSetupShadowPreprocessorV2`	Represents a diffraction setup implementation using material data from shadow bragg preprocessor V1 photon energy in eV dSpacing returns A units are in SI.
`diffraction.DiffractionExceptions`	Exception classes with ad-hoc messages.
`diffraction.DiffractionResult`	Object to hold the diffraction results.
`diffraction.GeometryType`	Represents geometry types/setups: Bragg diffraction, BraggTransmission, Laue diffraction, Laue transmission.
`diffraction.PerfectCrystalDiffraction`	Calculates crystal diffraction according to Guigay and Zachariasen formalisms of the dynamic theory of crystal diffraction for perfect crystals.

polarization

crystalpy.polarization classes for polarization calculations

`polarization.CrystalPhasePlate`	Represents a Phase Plate by a perfect crystal.
`polarization.MuellerDiffraction`	Represents Mueller diffraction setup.
`polarization.MuellerMatrix`	Represents a Mueller matrix.
`polarization.MuellerResult`	Represents Mueller calculation results.

util

crystalpy.util classes and methods with utilities and tools

`util.Vector`	Represents a 3d vector.
`util.StokesVector`	Represents a Stokes vector (four components s0, s1, s2, s3).
`util.Photon`	Represents a photon defined by its energy and direction vector
`util.PhotonBunch`	A stack of photons, each one characterized by energy and direction.
`util.PolarizedPhoton`	This object represents a polarized photon, characterized by energy, direction vector and Stokes parameters.
`util.PolarizedPhotonBunch`	A stack of polarized photons characterized by photon energy, direction vector and Stokes vector.
`util.ComplexAmplitudePhoton`	Represents a photon defined by its energy, direction vector and pi and sigma complex amplitudes.
`util.ComplexAmplitudePhotonBunch`	A stack of "complex-amplitude" photons characterized by photon energy, direction vector and sigma and pi complex amplitudes.
`util.CalculationStrategy`	Numeric strategy for calculation.
`util.bragg_preprocessor_file_io`	Utilities to read and write Bragg preprocessor files and dictionaries.
`util.calc_xcrystal`	Utility functions for crystal diffraction calculations (xcrystal tools).
`util.PlotData1D`	---OK---