Package API

This page lists main classes in this package.

srxraylib classes.

metrology

srxraylib.metrology classes and functions for metrology

`metrology.dabam`	dabam: (dataBase for metrology)
`metrology.profiles_simulation`	This is a collection of functions to simulate profiles that can be used for describing surface errors in optical surfaces
`metrology.error_profile_calculator`	Error profile calculator for mirror surface metrology.
`metrology.make_json_summary`	This program makes a summary file pf the dabam contents to accelerate the search.

srxraylib.plot functions for plots

srxraylib.sources functions for synchrotron radiation sources

srfunc: calculates synchrotron radiation emission (radiation and angle distributions).

srxraylib.profiles mirror profile calculators

`profiles.benders.bender_io`	I/O utilities for mirror bender profiles.
`profiles.benders.bender_manager`	Base class for mirror bender managers.
`profiles.benders.fixed_rods_bender_manager`	Bender manager for fixed-rod mirror bender systems.
`profiles.benders.flexural_hinge_bender_manager`	Bender manager for flexural-hinge mirror bender systems.

srxraylib.util classes and functions with utilities and tools

`util.data_structures`	Utility to mimic IGOR-like vector and matrix classes and functions.
`util.inverse_method_sampler`	Classes for creating random points following a given numeric distribution using the inverse method.
`util.chemical_formula`	Utilities for parsing and computing properties of chemical formulas.
`util.custom_distribution`	Custom probability distribution sampler via inverse CDF.
`util.histograms`	Histogram utilities for beam and profile data analysis.
`util.random_distributions`	Random number generation with arbitrary probability distributions.
`util.threading`	Threading utilities for parallel calculations.

srxraylib.waveoptics 1D and 2D wave-optics tools (deprecated, use wofry/wofrylib)

`waveoptics.wavefront`	1D wavefront class (deprecated, use wofry/wofrylib instead).
`waveoptics.wavefront2D`	2D wavefront class (deprecated, use wofry/wofrylib instead).
`waveoptics.propagator`	1D wave-optics propagators.
`waveoptics.propagator2D`	2D wave-optics propagators: Fraunhofer, Fresnel, etc.
`waveoptics.polarization`	Polarization class (deprecated, use wofry/wofrylib instead).