shadow4 package

Subpackages

• shadow4.beam package
  • Submodules
  • shadow4.beam.s4_beam module
    • S4Beam
      • S4Beam.N
      • S4Beam.Nbad
      • S4Beam.Ngood
      • S4Beam.Nstored
      • S4Beam.add_phase_p()
      • S4Beam.add_phase_s()
      • S4Beam.add_phases()
      • S4Beam.append_beam()
      • S4Beam.apply_attenuation()
      • S4Beam.apply_boundaries_shadow()
      • S4Beam.apply_boundaries_syned()
      • S4Beam.apply_complex_reflectivities()
      • S4Beam.apply_complex_reflectivity_p()
      • S4Beam.apply_complex_reflectivity_s()
      • S4Beam.apply_reflectivities()
      • S4Beam.apply_reflectivity_p()
      • S4Beam.apply_reflectivity_s()
      • S4Beam.calculate_hew()
      • S4Beam.calculate_hew_x()
      • S4Beam.calculate_hew_z()
      • S4Beam.change_to_image_reference_system()
      • S4Beam.clean_lost_rays()
      • S4Beam.column_names()
      • S4Beam.column_names_formatted()
      • S4Beam.column_names_formatted_with_column_number()
      • S4Beam.column_names_with_column_number()
      • S4Beam.column_short_names()
      • S4Beam.column_short_names_with_column_number()
      • S4Beam.column_units()
      • S4Beam.crop_ellipse()
      • S4Beam.crop_ellipse_with_hole()
      • S4Beam.crop_rectangle()
      • S4Beam.difference()
      • S4Beam.duplicate()
      • S4Beam.efields_orthogonal()
      • S4Beam.fixnan()
      • S4Beam.focnew_coeffs()
      • S4Beam.generate_source()
      • S4Beam.get_UVW()
      • S4Beam.get_average()
      • S4Beam.get_column()
      • S4Beam.get_columns()
      • S4Beam.get_efield_directions()
      • S4Beam.get_good_range()
      • S4Beam.get_intensity()
      • S4Beam.get_jones()
      • S4Beam.get_jones_components()
      • S4Beam.get_local_directions_sigma_pi()
      • S4Beam.get_number_of_rays()
      • S4Beam.get_photon_energy_eV()
      • S4Beam.get_photon_wavelength()
      • S4Beam.get_rays()
      • S4Beam.get_standard_deviation()
      • S4Beam.histo1()
      • S4Beam.histo2()
      • S4Beam.identical()
      • S4Beam.info()
      • S4Beam.initialize_as_pencil()
      • S4Beam.initialize_from_array()
      • S4Beam.intensity()
      • S4Beam.is_cleaned()
      • S4Beam.isnan()
      • S4Beam.load_h5()
      • S4Beam.rays_bad
      • S4Beam.rays_good
      • S4Beam.retrace()
      • S4Beam.rot_back()
      • S4Beam.rot_for()
      • S4Beam.rotate()
      • S4Beam.set_column()
      • S4Beam.set_jones()
      • S4Beam.set_jones_components()
      • S4Beam.set_photon_energy_eV()
      • S4Beam.set_photon_wavelength()
      • S4Beam.trace_oe()
      • S4Beam.translation()
      • S4Beam.write_h5()
  • Module contents
• shadow4.beamline package
  • Subpackages
    • shadow4.beamline.optical_elements package
      • Subpackages
      • Module contents
  • Submodules
  • shadow4.beamline.s4_beamline module
    • S4Beamline
      • S4Beamline.append_beamline_element()
      • S4Beamline.distances_summary()
      • S4Beamline.duplicate()
      • S4Beamline.oeinfo()
      • S4Beamline.run_beamline()
      • S4Beamline.sourcinfo()
      • S4Beamline.sysinfo()
      • S4Beamline.syspositions()
      • S4Beamline.to_python_code()
  • shadow4.beamline.s4_beamline_element module
    • S4BeamlineElement
      • S4BeamlineElement.get_input_beam()
      • S4BeamlineElement.get_movements()
      • S4BeamlineElement.info()
      • S4BeamlineElement.set_input_beam()
      • S4BeamlineElement.set_movements()
      • S4BeamlineElement.to_python_code()
      • S4BeamlineElement.to_python_code_coordinates()
      • S4BeamlineElement.to_python_code_movements()
      • S4BeamlineElement.trace_beam()
  • shadow4.beamline.s4_beamline_element_movements module
    • S4BeamlineElementMovements
      • S4BeamlineElementMovements.get_offsets()
      • S4BeamlineElementMovements.get_rotations()
  • shadow4.beamline.s4_optical_element_decorators module
    • S4ConicOpticalElementDecorator
      • S4ConicOpticalElementDecorator.get_optical_surface_instance()
    • S4CurvedOpticalElementDecorator
      • S4CurvedOpticalElementDecorator.get_surface_shape_instance()
    • S4EllipsoidOpticalElementDecorator
      • S4EllipsoidOpticalElementDecorator.get_optical_surface_instance()
    • S4HyperboloidOpticalElementDecorator
      • S4HyperboloidOpticalElementDecorator.get_optical_surface_instance()
    • S4NumericalMeshOpticalElementDecorator
      • S4NumericalMeshOpticalElementDecorator.get_optical_surface_instance()
    • S4OpticalElementDecorator
      • S4OpticalElementDecorator.get_info()
      • S4OpticalElementDecorator.get_optical_surface_instance()
      • S4OpticalElementDecorator.get_surface_shape_instance()
      • S4OpticalElementDecorator.interthickness()
      • S4OpticalElementDecorator.to_python_code()
    • S4ParaboloidOpticalElementDecorator
      • S4ParaboloidOpticalElementDecorator.get_optical_surface_instance()
    • S4PlaneOpticalElementDecorator
      • S4PlaneOpticalElementDecorator.get_optical_surface_instance()
      • S4PlaneOpticalElementDecorator.get_surface_shape_instance()
    • S4RefractiveLensOpticalElementDecorator
      • S4RefractiveLensOpticalElementDecorator.get_optical_surface_instance()
    • S4SphereOpticalElementDecorator
      • S4SphereOpticalElementDecorator.get_optical_surface_instance()
    • S4ToroidOpticalElementDecorator
      • S4ToroidOpticalElementDecorator.get_optical_surface_instance()
    • SurfaceCalculation
      • SurfaceCalculation.EXTERNAL
      • SurfaceCalculation.INTERNAL
  • Module contents
• shadow4.optical_surfaces package
  • Submodules
  • shadow4.optical_surfaces.s4_conic module
    • S4Conic
      • S4Conic.calculate_intercept()
      • S4Conic.calculate_intercept_and_choose_solution()
      • S4Conic.choose_solution()
      • S4Conic.duplicate()
      • S4Conic.get_coefficients()
      • S4Conic.get_normal()
      • S4Conic.height()
      • S4Conic.info()
      • S4Conic.initialize_as_ellipsoid_from_external_parameters()
      • S4Conic.initialize_as_ellipsoid_from_focal_distances()
      • S4Conic.initialize_as_hyperboloid_from_external_parameters()
      • S4Conic.initialize_as_hyperboloid_from_focal_distances()
      • S4Conic.initialize_as_paraboloid_from_external_parameters()
      • S4Conic.initialize_as_paraboloid_from_focal_distances()
      • S4Conic.initialize_as_plane()
      • S4Conic.initialize_as_sphere_from_external_parameters()
      • S4Conic.initialize_as_sphere_from_focal_distances()
      • S4Conic.initialize_from_coefficients()
      • S4Conic.rotate_and_translate_coefficients()
      • S4Conic.set_coefficients()
      • S4Conic.set_ellipsoid_from_external_parameters()
      • S4Conic.set_hyperboloid_from_external_parameters()
      • S4Conic.set_paraboloid_from_external_parameters()
      • S4Conic.set_sphere_from_external_parameters()
      • S4Conic.surface_height()
  • shadow4.optical_surfaces.s4_mesh module
    • S4Mesh
      • S4Mesh.add_to_mesh()
      • S4Mesh.calculate_intercept()
      • S4Mesh.calculate_intercept_and_choose_solution()
      • S4Mesh.duplicate()
      • S4Mesh.get_mesh_x_y()
      • S4Mesh.get_mesh_z()
      • S4Mesh.get_normal()
      • S4Mesh.info()
      • S4Mesh.load_file()
      • S4Mesh.load_h5file()
      • S4Mesh.load_surface_data()
      • S4Mesh.load_surface_data_arrays()
      • S4Mesh.surface_height()
  • shadow4.optical_surfaces.s4_optical_surface module
    • S4OpticalSurface
      • S4OpticalSurface.apply_grating_diffraction_on_beam()
      • S4OpticalSurface.apply_refraction_on_beam()
      • S4OpticalSurface.apply_specular_reflection_on_beam()
      • S4OpticalSurface.calculate_intercept()
      • S4OpticalSurface.calculate_intercept_and_choose_solution()
      • S4OpticalSurface.calculate_intercept_on_beam()
      • S4OpticalSurface.choose_solution()
      • S4OpticalSurface.duplicate()
      • S4OpticalSurface.get_normal()
      • S4OpticalSurface.info()
      • S4OpticalSurface.surface_height()
      • S4OpticalSurface.write_mesh_file()
      • S4OpticalSurface.write_mesh_h5file()
      • S4OpticalSurface.write_shadow_surface()
  • shadow4.optical_surfaces.s4_toroid module
    • S4Toroid
      • S4Toroid.calculate_intercept()
      • S4Toroid.calculate_intercept_and_choose_solution()
      • S4Toroid.calculate_intercept_and_choose_solution_newton()
      • S4Toroid.choose_solution()
      • S4Toroid.duplicate()
      • S4Toroid.get_normal()
      • S4Toroid.get_tangential_and_sagittal_radii()
      • S4Toroid.get_toroid_radii()
      • S4Toroid.info()
      • S4Toroid.set_cylindrical()
      • S4Toroid.set_f_torus()
      • S4Toroid.set_from_focal_distances()
      • S4Toroid.set_tangential_and_sagittal_radii()
      • S4Toroid.set_toroid_radii()
      • S4Toroid.surface_height()
      • S4Toroid.switch_convexity()
  • Module contents
• shadow4.physical_models package
  • Subpackages
    • shadow4.physical_models.bragg package
      • Submodules
      • shadow4.physical_models.bragg.bragg module
      • Module contents
    • shadow4.physical_models.mlayer package
      • Submodules
      • shadow4.physical_models.mlayer.mlayer module
      • Module contents
    • shadow4.physical_models.prerefl package
      • Submodules
      • shadow4.physical_models.prerefl.prerefl module
      • Module contents
  • Module contents
• shadow4.sources package
  • Subpackages
    • shadow4.sources.bending_magnet package
      • Submodules
      • shadow4.sources.bending_magnet.s4_bending_magnet module
      • shadow4.sources.bending_magnet.s4_bending_magnet_light_source module
      • Module contents
    • shadow4.sources.source_geometrical package
      • Submodules
      • shadow4.sources.source_geometrical.probability_distributions module
      • shadow4.sources.source_geometrical.source_gaussian module
      • shadow4.sources.source_geometrical.source_geometrical module
      • shadow4.sources.source_geometrical.source_grid_cartesian module
      • shadow4.sources.source_geometrical.source_grid_polar module
      • Module contents
    • shadow4.sources.undulator package
      • Submodules
      • shadow4.sources.undulator.calculate_undulator_emission module
      • shadow4.sources.undulator.calculate_undulator_emission_pysru module
      • shadow4.sources.undulator.calculate_undulator_emission_srw module
      • shadow4.sources.undulator.s4_undulator module
      • shadow4.sources.undulator.s4_undulator_gaussian module
      • shadow4.sources.undulator.s4_undulator_gaussian_light_source module
      • shadow4.sources.undulator.s4_undulator_light_source module
      • Module contents
    • shadow4.sources.wiggler package
      • Submodules
      • shadow4.sources.wiggler.s4_wiggler module
      • shadow4.sources.wiggler.s4_wiggler_light_source module
      • shadow4.sources.wiggler.s4_wiggler_optimized_light_source module
      • Module contents
  • Submodules
  • shadow4.sources.s4_electron_beam module
    • S4ElectronBeam
      • S4ElectronBeam.to_python_code()
  • shadow4.sources.s4_light_source module
    • S4LightSource
      • S4LightSource.calculate_spectrum()
      • S4LightSource.get_beam()
      • S4LightSource.get_info()
      • S4LightSource.get_nrays()
      • S4LightSource.get_seed()
      • S4LightSource.set_nrays()
      • S4LightSource.set_seed()
      • S4LightSource.to_python_code()
  • shadow4.sources.s4_light_source_base module
    • S4LightSourceBase
      • S4LightSourceBase.calculate_spectrum()
      • S4LightSourceBase.get_beam()
      • S4LightSourceBase.get_info()
      • S4LightSourceBase.get_nrays()
      • S4LightSourceBase.get_seed()
      • S4LightSourceBase.set_nrays()
      • S4LightSourceBase.set_seed()
      • S4LightSourceBase.to_python_code()
  • shadow4.sources.s4_light_source_from_beamlines module
    • S4LightSourceFromBeamlines
      • S4LightSourceFromBeamlines.append_beamline()
      • S4LightSourceFromBeamlines.calculate_spectrum()
      • S4LightSourceFromBeamlines.get_beam()
      • S4LightSourceFromBeamlines.get_info()
      • S4LightSourceFromBeamlines.number_of_beamlines()
      • S4LightSourceFromBeamlines.to_python_code()
  • shadow4.sources.s4_light_source_from_file module
    • S4LightSourceFromFile
      • S4LightSourceFromFile.calculate_spectrum()
      • S4LightSourceFromFile.get_beam()
      • S4LightSourceFromFile.get_info()
      • S4LightSourceFromFile.to_python_code()
  • Module contents
• shadow4.tools package
  • Submodules
  • shadow4.tools.arrayofvectors module
    • vector_add_scalar()
    • vector_cross()
    • vector_default_efields()
    • vector_diff()
    • vector_dot()
    • vector_modulus()
    • vector_modulus_square()
    • vector_multiply_scalar()
    • vector_norm()
    • vector_reflection()
    • vector_refraction()
    • vector_rotate_around_axis()
    • vector_scattering()
    • vector_sum()
  • shadow4.tools.beamline_tools module
    • beamline_get_beam_at_element()
    • beamline_get_last_beam()
    • beamline_get_source_beam()
    • flux_summary()
    • focnew()
    • focnew_scan()
    • focnew_scan_full_beamline()
  • shadow4.tools.graphics module
    • ArgsError
    • ErrorMsg()
    • Histo1_CheckArg()
    • Histo1_Ticket
    • Histo1_write()
    • NoValueSelectedError
    • calcFWHM()
    • findIndex()
    • getLabel()
    • getshcol_CheckArg()
    • getshonecol_CheckArg()
    • histo1()
    • plotxy()
    • plotxy_CheckArg()
    • plotxy_Ticket
    • setGoodRange()
  • shadow4.tools.logger module
    • is_debug()
    • is_verbose()
    • printlog()
    • set_debug()
    • set_verbose()
  • shadow4.tools.srw module
  • Module contents

Module contents