Package API

This page lists main classes in this package.

beam

shadow4.beam The S4 beam

shadow4.beam.s4_beam

Defines the shadow4 beam and associated methods and utilities.

sources

shadow4.sources The S4 sources

• shadow4.sources.source_geometrical The S4 geometrical sources

  shadow4.sources.source_geometrical.source_geometrical	Geometrical sources.
  shadow4.sources.source_geometrical.source_grid_cartesian	Grid source defined in cartesian coordinates.
  shadow4.sources.source_geometrical.source_grid_polar	Grid source defined in polar coordinates.
  shadow4.sources.source_geometrical.source_gaussian	This is a Gaussian source in both space and divergence coordinates.

• shadow4.sources.bending_magnet The S4 bending magnet

  shadow4.sources.bending_magnet.s4_bending_magnet	Bending magnet magnetic structure.
  shadow4.sources.bending_magnet.s4_bending_magnet_light_source	Bending magnet light source.

• shadow4.sources.wiggler The S4 wiggler

  shadow4.sources.wiggler.s4_wiggler	S4 Wiggler magnetic structure.
  shadow4.sources.wiggler.s4_wiggler_light_source	Wiggler light source.

• shadow4.sources.undulator The S4 undulators

  shadow4.sources.undulator.s4_undulator_gaussian	S4 Undulator magnetic structure.
  shadow4.sources.undulator.s4_undulator	S4 Undulator magnetic structure.
  shadow4.sources.undulator.s4_undulator_gaussian_light_source	Undulator light source.

beamline optical elements

shadow4.beamline.optical_elements The S4 optical elements

• shadow4.beamline.optical_elements.absorbers The absorbers, slits, sops, screens

  shadow4.beamline.optical_elements.absorbers.s4_screen

  The S4 screen optical element: it deals with screens, slits, beam-stoppers and absorbers (as in shadow3).

• shadow4.beamline.optical_elements.mirrors The mirrors

  shadow4.beamline.optical_elements.mirrors.s4_mirror	The s4 mirror base class (optical element and beamline element).
  shadow4.beamline.optical_elements.mirrors.s4_plane_mirror	The s4 plane mirror (optical element and beamline element).
  shadow4.beamline.optical_elements.mirrors.s4_sphere_mirror	The s4 sphere mirror (optical element and beamline element).
  shadow4.beamline.optical_elements.mirrors.s4_toroid_mirror	The s4 toroid mirror (optical element and beamline element).
  shadow4.beamline.optical_elements.mirrors.s4_ellipsoid_mirror	The s4 ellipsoid mirror (optical element and beamline element).
  shadow4.beamline.optical_elements.mirrors.s4_paraboloid_mirror	The s4 paraboloid mirror (optical element and beamline element).
  shadow4.beamline.optical_elements.mirrors.s4_hyperboloid_mirror	The s4 hyperboloid mirror (optical element and beamline element).
  shadow4.beamline.optical_elements.mirrors.s4_conic_mirror	The s4 conic mirror (optical element and beamline element).
  shadow4.beamline.optical_elements.mirrors.s4_numerical_mesh_mirror	The s4 numerical mesh mirror (optical element and beamline element).
  shadow4.beamline.optical_elements.mirrors.s4_additional_numerical_mesh_mirror	The s4 additional numerical mesh mirror (optical element and beamline element).

• shadow4.beamline.optical_elements.gratings The gratings

  shadow4.beamline.optical_elements.gratings.s4_grating	The s4 grating base class (optical element and beamline element).
  shadow4.beamline.optical_elements.gratings.s4_plane_grating	The s4 plane grating (optical element and beamline element).
  shadow4.beamline.optical_elements.gratings.s4_sphere_grating	The s4 sphere grating (optical element and beamline element).
  shadow4.beamline.optical_elements.gratings.s4_toroid_grating	The s4 toroid grating (optical element and beamline element).
  shadow4.beamline.optical_elements.gratings.s4_ellipsoid_grating	The s4 ellipsoid grating (optical element and beamline element).
  shadow4.beamline.optical_elements.gratings.s4_paraboloid_grating	The s4 paraboloid grating (optical element and beamline element).
  shadow4.beamline.optical_elements.gratings.s4_hyperboloid_grating	The s4 hyperboloid grating (optical element and beamline element).
  shadow4.beamline.optical_elements.gratings.s4_conic_grating	The s4 conic grating (optical element and beamline element).
  shadow4.beamline.optical_elements.gratings.s4_numerical_mesh_grating	The s4 numerical mesh grating (optical element and beamline element).
  shadow4.beamline.optical_elements.gratings.s4_additional_numerical_mesh_grating	The s4 additional numerical mesh grating (optical element and beamline element).

• shadow4.beamline.optical_elements.crystals The crystals

  shadow4.beamline.optical_elements.crystals.s4_crystal	The s4 crystal base class (optical element and beamline element).
  shadow4.beamline.optical_elements.crystals.s4_plane_crystal	The s4 plane crystal (optical element and beamline element).
  shadow4.beamline.optical_elements.crystals.s4_sphere_crystal	The s4 sphere crystal (optical element and beamline element).
  shadow4.beamline.optical_elements.crystals.s4_toroid_crystal	The s4 toroid crystal (optical element and beamline element).
  shadow4.beamline.optical_elements.crystals.s4_ellipsoid_crystal	The s4 ellipsoid crystal (optical element and beamline element).
  shadow4.beamline.optical_elements.crystals.s4_paraboloid_crystal	The s4 paraboloid crystal (optical element and beamline element).
  shadow4.beamline.optical_elements.crystals.s4_hyperboloid_crystal	The s4 hyperboloid crystal (optical element and beamline element).
  shadow4.beamline.optical_elements.crystals.s4_conic_crystal	The s4 conic crystal (optical element and beamline element).
  shadow4.beamline.optical_elements.crystals.s4_numerical_mesh_crystal	The s4 numerical mesh crystal (optical element and beamline element).
  shadow4.beamline.optical_elements.crystals.s4_additional_numerical_mesh_crystal	The s4 additional numerical mesh crystal (optical element and beamline element).

• shadow4.beamline.optical_elements.multilayers The multilayers

  shadow4.beamline.optical_elements.multilayers.s4_multilayer	The s4 multilayer base class (optical element and beamline element).
  shadow4.beamline.optical_elements.multilayers.s4_plane_multilayer	The s4 plane multilayer (optical element and beamline element).
  shadow4.beamline.optical_elements.multilayers.s4_sphere_multilayer	The s4 sphere multilayer (optical element and beamline element).
  shadow4.beamline.optical_elements.multilayers.s4_toroid_multilayer	The s4 toroid multilayer (optical element and beamline element).
  shadow4.beamline.optical_elements.multilayers.s4_ellipsoid_multilayer	The s4 ellipsoid multilayer (optical element and beamline element).
  shadow4.beamline.optical_elements.multilayers.s4_paraboloid_multilayer	The s4 paraboloid multilayer (optical element and beamline element).
  shadow4.beamline.optical_elements.multilayers.s4_hyperboloid_multilayer	The s4 hyperboloid multilayer (optical element and beamline element).
  shadow4.beamline.optical_elements.multilayers.s4_conic_multilayer	The s4 conic multilayer (optical element and beamline element).
  shadow4.beamline.optical_elements.multilayers.s4_numerical_mesh_multilayer	The s4 numerical mesh multilayer (optical element and beamline element).
  shadow4.beamline.optical_elements.multilayers.s4_additional_numerical_mesh_multilayer	The s4 additional numerical mesh multilayer (optical element and beamline element).

• shadow4.beamline.optical_elements.refractors The refractors

  shadow4.beamline.optical_elements.refractors.s4_interface	S4 refractive interface.
  shadow4.beamline.optical_elements.refractors.s4_lens	The s4 refractive lens (optical element and beamline element).
  shadow4.beamline.optical_elements.refractors.s4_crl	The s4 compound refractive lens, CRL (optical element and beamline element).
  shadow4.beamline.optical_elements.refractors.s4_transfocator	The s4 transfocator (optical element and beamline element).
  shadow4.beamline.optical_elements.refractors.s4_conic_interface	The s4 conic refractive interface (optical element and beamline element).
  shadow4.beamline.optical_elements.refractors.s4_numerical_mesh_interface	The s4 numerical mesh refractive interface (optical element and beamline element).
  shadow4.beamline.optical_elements.refractors.s4_additional_numerical_mesh_interface	The s4 additional numerical mesh refractive interface (optical element and beamline element).

• shadow4.beamline.optical_elements.ideal_elements The ideal elements

  shadow4.beamline.optical_elements.ideal_elements.s4_beam_movement	The s4 beam movement ideal element (optical element and beamline element).
  shadow4.beamline.optical_elements.ideal_elements.s4_empty	The s4 empty (pass-through) ideal element (optical element and beamline element).
  shadow4.beamline.optical_elements.ideal_elements.s4_ideal_lens	The s4 ideal lens (optical element and beamline element).
  shadow4.beamline.optical_elements.ideal_elements.s4_ideal_fzp	The s4 ideal Fresnel zone plate (optical element and beamline element).

• shadow4.beamline.optical_elements.compound The compound elements

  shadow4.beamline.optical_elements.compound.s4_compound

  The s4 compound optical element (combination of multiple beamline elements).

beamline

shadow4.beamline The S4 beamline

shadow4.beamline.s4_beamline	Defines the S4 beamline.
shadow4.beamline.s4_beamline_element	Defines the S4 beamline element.
shadow4.beamline.s4_beamline_element_movements	Container for the variables describing the movements of a S4 beamline element.
shadow4.beamline.s4_optical_element_decorators	Defines the functionality for shadow4 optical elements.

sources (base classes)

shadow4.sources The S4 source base classes

shadow4.sources.s4_light_source_base	Defines the a Base LightSource to support non-synchrotron sources.
shadow4.sources.s4_light_source	Defines the shadow4 synchrotron LightSource (the base class of beanding magnet, wiggler and undulator lightsources).
shadow4.sources.s4_electron_beam	Defines the shadow4 electron beam.
shadow4.sources.s4_light_source_from_file	Defines the a LightSource with a beam defined in a HDF5 file.
shadow4.sources.s4_light_source_from_beamlines	Defines the a LightSource merging several beamlines.

• shadow4.sources.wiggler The S4 wiggler (optimized)

  shadow4.sources.wiggler.s4_wiggler_optimized_light_source

optical surfaces

shadow4.optical_surfaces The S4 optical surface implementations

shadow4.optical_surfaces.s4_optical_surface	Abstract class defining the interfaces of the optical surfaces to be implemented in the subclasses.
shadow4.optical_surfaces.s4_conic	Defines the shadow4 Conic class to deal with conic surfaces (plane, sphere, ellipsoid, paraboloid and hyperboloid).
shadow4.optical_surfaces.s4_toroid	Defines the shadow4 Toroid class to deal with a toroidal surface (Quartic equation).
shadow4.optical_surfaces.s4_mesh	Defines the shadow4 Mesh class to deal with a numerical surfaces (defined by an array of points).

physical models

shadow4.physical_models Physical model calculators

shadow4.physical_models.bragg.bragg	Crystal structure factor preprocessor for Bragg diffraction calculations.
shadow4.physical_models.mlayer.mlayer	python version of the multilayer code in shadow.
shadow4.physical_models.prerefl.prerefl	python version of the mirror reflectivity code and refractive index calculations in shadow.

tools

shadow4.tools Utility modules

shadow4.tools.arrayofvectors	Operations on arrays of 3D vectors with shape (n_vectors, 3).
shadow4.tools.beamline_tools	Tools (functions) to operate with the beamline (instance of S4Beamline).
shadow4.tools.graphics	Matplotlib-based plotting tools for shadow4 beam data.
shadow4.tools.logger	Logging verbosity helpers for shadow4.