srxraylib package

Subpackages

• srxraylib.metrology package
  • Submodules
  • srxraylib.metrology.dabam module
    • autocorrelationfunction()
    • cdf()
    • dabam
      • dabam.autocorrelation_heights()
      • dabam.autocorrelation_slopes()
      • dabam.csd_heights()
      • dabam.csd_slopes()
      • dabam.dabam_summary_dictionary_from_json_indexation()
      • dabam.dabam_summary_dictionary_from_scratch()
      • dabam.file_data()
      • dabam.file_metadata()
      • dabam.get_default_server()
      • dabam.get_input_value()
      • dabam.get_input_value_help()
      • dabam.get_input_value_short_name()
      • dabam.get_inputs_as_dictionary()
      • dabam.get_server()
      • dabam.info_profiles()
      • dabam.initialize_from_entry_number()
      • dabam.initialize_from_external_data()
      • dabam.initialize_from_local_server()
      • dabam.is_remote_access()
      • dabam.load()
      • dabam.load_json_summary()
      • dabam.make_calculations()
      • dabam.metadata_set_info()
      • dabam.plot()
      • dabam.reset()
      • dabam.set_default_server()
      • dabam.set_entry()
      • dabam.set_input_detrendingWindowFactor()
      • dabam.set_input_entryNumber()
      • dabam.set_input_localFileRoot()
      • dabam.set_input_multiply()
      • dabam.set_input_nbinH()
      • dabam.set_input_nbinS()
      • dabam.set_input_outputFileRoot()
      • dabam.set_input_oversample()
      • dabam.set_input_plot()
      • dabam.set_input_resetZeroHeight()
      • dabam.set_input_setDetrending()
      • dabam.set_input_shadowCalc()
      • dabam.set_input_shadowFactor()
      • dabam.set_input_shadowNx()
      • dabam.set_input_shadowNy()
      • dabam.set_input_shadowWidth()
      • dabam.set_input_silent()
      • dabam.set_input_summary()
      • dabam.set_input_useAbscissasColumn()
      • dabam.set_input_useHeightsOrSlopes()
      • dabam.set_input_useOrdinatesColumn()
      • dabam.set_inputs_from_dictionary()
      • dabam.set_remote_access()
      • dabam.set_server()
      • dabam.statistics_summary()
      • dabam.stdev_profile_heights()
      • dabam.stdev_profile_slopes()
      • dabam.stdev_psd_heights()
      • dabam.stdev_psd_slopes()
      • dabam.stdev_user_heights()
      • dabam.stdev_user_slopes()
      • dabam.write_output_dabam_files()
      • dabam.write_template()
    • dabam_summary()
    • dabam_summary_dictionary()
    • func_ellipse_slopes()
    • main()
    • make_json_summary()
    • moment()
    • psd()
    • write_shadowSurface()
  • srxraylib.metrology.dabam_tests module
    • data1()
    • test_dabam_names()
    • test_dabam_stdev_slopes()
    • test_entry()
    • test_entry_elliptical()
    • test_entry_file()
    • test_entry_text()
    • test_load_dictionary()
    • test_local_server()
    • test_summary_dictionary()
    • test_write_dabam_formatted_files()
  • srxraylib.metrology.error_profile_calculator module
    • DabamInputParameters
    • ErrorProfileInputParameters
    • calculate_dabam_profile()
    • calculate_heigth_profile()
  • srxraylib.metrology.make_json_summary module
  • srxraylib.metrology.profiles_simulation module
    • combine_two_transversal_profiles()
    • create_2D_profile_from_1D()
    • create_simulated_1D_file_APS()
    • create_simulated_2D_profile_APS()
    • simulate_profile_1D()
    • simulate_profile_1D_fractal()
    • simulate_profile_1D_gaussian()
    • simulate_profile_2D()
    • slopes()
  • Module contents
• srxraylib.plot package
  • Submodules
  • srxraylib.plot.gol module
  • Module contents
• srxraylib.profiles package
  • Subpackages
    • srxraylib.profiles.benders package
      • Submodules
      • srxraylib.profiles.benders.bender_io module
      • srxraylib.profiles.benders.bender_manager module
      • srxraylib.profiles.benders.fixed_rods_bender_manager module
      • srxraylib.profiles.benders.flexural_hinge_bender_manager module
      • Module contents
    • srxraylib.profiles.diaboloid package
      • Submodules
      • srxraylib.profiles.diaboloid.diaboloid_calculator module
      • srxraylib.profiles.diaboloid.fqs module
      • Module contents
  • Module contents
• srxraylib.sources package
  • Submodules
  • srxraylib.sources.srfunc module
    • fintk53()
    • kv_approx()
    • resample_array()
    • sync_ang()
    • sync_ene()
    • sync_f()
    • sync_f_sigma_and_pi()
    • sync_f_sigma_and_pi_approx()
    • sync_g1()
    • sync_hi()
    • wiggler_cdf()
    • wiggler_harmonics()
    • wiggler_nphoton()
    • wiggler_spectrum()
    • wiggler_spectrum_on_aperture()
    • wiggler_trajectory()
  • Module contents
• srxraylib.util package
  • Submodules
  • srxraylib.util.chemical_formula module
    • ChemicalFormulaParser
      • ChemicalFormulaParser.parse_formula()
    • Element
      • Element.addsyms()
      • Element.getweight()
    • ElementInFormula
    • ElementSequence
      • ElementSequence.addsyms()
      • ElementSequence.append()
      • ElementSequence.displaysyms()
      • ElementSequence.getsyms()
      • ElementSequence.getweight()
      • ElementSequence.set_count()
    • Tokenizer
      • Tokenizer.error()
      • Tokenizer.gettoken()
    • build_dict()
    • parse()
    • parse_sequence()
  • srxraylib.util.custom_distribution module
    • CustomDistribution
      • CustomDistribution.ndim
      • CustomDistribution.sum
  • srxraylib.util.data_structures module
    • ScaledArray
      • ScaledArray.delta()
      • ScaledArray.get_abscissas()
      • ScaledArray.get_scale_value()
      • ScaledArray.get_value()
      • ScaledArray.get_values()
      • ScaledArray.initialize()
      • ScaledArray.initialize_from_range()
      • ScaledArray.initialize_from_steps()
      • ScaledArray.interpolate_scale_value()
      • ScaledArray.interpolate_value()
      • ScaledArray.interpolate_values()
      • ScaledArray.offset()
      • ScaledArray.set_scale_from_range()
      • ScaledArray.set_scale_from_steps()
      • ScaledArray.set_value()
      • ScaledArray.set_values()
      • ScaledArray.size()
    • ScaledMatrix
      • ScaledMatrix.compute_interpolator()
      • ScaledMatrix.delta_x()
      • ScaledMatrix.delta_y()
      • ScaledMatrix.get_x_value()
      • ScaledMatrix.get_x_values()
      • ScaledMatrix.get_y_value()
      • ScaledMatrix.get_y_values()
      • ScaledMatrix.get_z_value()
      • ScaledMatrix.get_z_values()
      • ScaledMatrix.initialize()
      • ScaledMatrix.initialize_from_range()
      • ScaledMatrix.initialize_from_steps()
      • ScaledMatrix.interpolate_value()
      • ScaledMatrix.is_complex_matrix()
      • ScaledMatrix.offset_x()
      • ScaledMatrix.offset_y()
      • ScaledMatrix.set_scale_from_range()
      • ScaledMatrix.set_scale_from_steps()
      • ScaledMatrix.set_z_value()
      • ScaledMatrix.set_z_values()
      • ScaledMatrix.shape()
      • ScaledMatrix.size()
      • ScaledMatrix.size_x()
      • ScaledMatrix.size_y()
      • ScaledMatrix.x_coord
      • ScaledMatrix.y_coord
      • ScaledMatrix.z_values
  • srxraylib.util.h5_simple_writer module
  • srxraylib.util.histograms module
    • get_average()
    • get_fwhm()
    • get_rms()
    • get_sigma()
  • srxraylib.util.inverse_method_sampler module
    • Sampler1D
      • Sampler1D.abscissas()
      • Sampler1D.cdf()
      • Sampler1D.cdf_abscissas()
      • Sampler1D.get_n_sampled_points()
      • Sampler1D.get_n_sampled_points_and_histogram()
      • Sampler1D.get_sampled()
      • Sampler1D.get_sampled_and_histogram()
      • Sampler1D.pdf()
    • Sampler2D
      • Sampler2D.abscissas()
      • Sampler2D.cdf()
      • Sampler2D.get_n_sampled_points()
      • Sampler2D.get_n_sampled_points_x2()
      • Sampler2D.get_sampled()
      • Sampler2D.get_sampled_x2()
      • Sampler2D.pdf()
    • Sampler3D
      • Sampler3D.abscissas()
      • Sampler3D.cdf()
      • Sampler3D.get_n_sampled_points()
      • Sampler3D.get_sampled()
      • Sampler3D.pdf()
  • srxraylib.util.random_distributions module
    • AuxiliaryContainer
    • Container
      • Container.clone()
      • Container.copy_from()
      • Container.min_max()
    • Container1D
      • Container1D.cell_iter()
      • Container1D.index_iter()
      • Container1D.square_iter()
      • Container1D.window_iter()
      • Container1D.wrapped_square_iter()
      • Container1D.wrapped_window_iter()
    • Container2D
      • Container2D.cell_iter()
      • Container2D.index_iter()
      • Container2D.square_index_iter()
      • Container2D.square_iter()
      • Container2D.window_index_iter()
      • Container2D.window_iter()
      • Container2D.wrapped_square_index_iter()
      • Container2D.wrapped_square_iter()
      • Container2D.wrapped_window_index_iter()
      • Container2D.wrapped_window_iter()
    • Container3D
      • Container3D.cell_iter()
      • Container3D.index_iter()
      • Container3D.square_iter()
      • Container3D.window_iter()
      • Container3D.wrapped_square_iter()
      • Container3D.wrapped_window_iter()
    • Distribution2D
      • Distribution2D.get_samples()
      • Distribution2D.make_distribution()
    • Grid1D
      • Grid1D.cell_iter()
    • Grid2D
      • Grid2D.cell_iter()
    • Grid3D
    • GridBar3D
    • GridCol2D
    • GridCol3D
    • GridRow2D
    • GridRow3D
    • GridSliceXY
    • GridSliceXZ
    • GridSliceYZ
    • GridWindow1D
    • GridWindow2D
    • GridWindow3D
    • ListGrid2D
      • ListGrid2D.additem()
    • ListGrid3D
      • ListGrid3D.additem()
    • NormalisedInputCurve
    • PrincipleContainer
    • RandomQueue
      • RandomQueue.empty()
      • RandomQueue.pop()
      • RandomQueue.push()
    • ResponseCurve
      • ResponseCurve.getInputMax()
      • ResponseCurve.getInputMin()
    • XYResponseCurve
      • XYResponseCurve.findInputIndex()
      • XYResponseCurve.makeInverse()
    • complete_slice()
    • distribution_from_grid()
    • int_point_2d()
    • int_point_3d()
    • is_slice()
    • lerp()
    • line()
    • make_distribution_curve()
    • make_grid_1d()
    • make_grid_2d()
    • make_grid_3d()
    • points_to_grid()
    • points_to_grid_3d()
    • ramp()
    • sigmoid()
    • signum()
    • slice_len()
    • slice_mul()
    • srange()
  • srxraylib.util.threading module
    • Singleton
      • Singleton.Instance()
    • synchronized_method()
  • Module contents
• srxraylib.waveoptics package
  • Submodules
  • srxraylib.waveoptics.CompactAFReader module
  • srxraylib.waveoptics.NumpyToSRW module
  • srxraylib.waveoptics.polarization module
    • Polarization
      • Polarization.PI
      • Polarization.SIGMA
      • Polarization.TOTAL
  • srxraylib.waveoptics.propagator module
    • propagate_1D_fraunhofer()
    • propagate_1D_fresnel()
    • propagate_1D_fresnel_convolution()
    • propagate_1D_fresnel_radius()
    • propagate_1D_integral()
    • propagator1d_fourier_rescaling()
  • srxraylib.waveoptics.propagator2D module
    • propagate_2D_fraunhofer()
    • propagate_2D_fresnel()
    • propagate_2D_fresnel_convolution()
    • propagate_2D_fresnel_srw()
    • propagate_2D_integral()
    • propagator2d_fourier_rescaling()
    • propagator2d_fourier_rescaling_xy()
  • srxraylib.waveoptics.wavefront module
    • Wavefront1D
      • Wavefront1D.add_phase_shift()
      • Wavefront1D.add_phase_shifts()
      • Wavefront1D.apply_ideal_lens()
      • Wavefront1D.apply_slit()
      • Wavefront1D.delta()
      • Wavefront1D.duplicate()
      • Wavefront1D.electric_field_array
      • Wavefront1D.get_abscissas()
      • Wavefront1D.get_amplitude()
      • Wavefront1D.get_complex_amplitude()
      • Wavefront1D.get_complex_amplitude_from_abscissas()
      • Wavefront1D.get_intensity()
      • Wavefront1D.get_interpolated_amplitude()
      • Wavefront1D.get_interpolated_amplitudes()
      • Wavefront1D.get_interpolated_complex_amplitude()
      • Wavefront1D.get_interpolated_complex_amplitudes()
      • Wavefront1D.get_interpolated_intensities()
      • Wavefront1D.get_interpolated_intensity()
      • Wavefront1D.get_interpolated_phase()
      • Wavefront1D.get_interpolated_phases()
      • Wavefront1D.get_normalized_intensity()
      • Wavefront1D.get_phase()
      • Wavefront1D.get_wavelength()
      • Wavefront1D.get_wavenumber()
      • Wavefront1D.initialize_wavefront()
      • Wavefront1D.initialize_wavefront_from_arrays()
      • Wavefront1D.initialize_wavefront_from_range()
      • Wavefront1D.initialize_wavefront_from_steps()
      • Wavefront1D.offset()
      • Wavefront1D.rescale_amplitude()
      • Wavefront1D.rescale_amplitudes()
      • Wavefront1D.set_complex_amplitude()
      • Wavefront1D.set_photon_energy()
      • Wavefront1D.set_plane_wave_from_amplitude_and_phase()
      • Wavefront1D.set_plane_wave_from_complex_amplitude()
      • Wavefront1D.set_spherical_wave()
      • Wavefront1D.set_wavelength()
      • Wavefront1D.set_wavenumber()
      • Wavefront1D.size()
      • Wavefront1D.wavelength
    • test_plane_wave()
  • srxraylib.waveoptics.wavefront2D module
    • Wavefront2D
      • Wavefront2D.add_phase_shift()
      • Wavefront2D.add_phase_shifts()
      • Wavefront2D.apply_ideal_lens()
      • Wavefront2D.apply_pinhole()
      • Wavefront2D.apply_slit()
      • Wavefront2D.delta()
      • Wavefront2D.duplicate()
      • Wavefront2D.electric_field_array
      • Wavefront2D.get_amplitude()
      • Wavefront2D.get_complex_amplitude()
      • Wavefront2D.get_coordinate_x()
      • Wavefront2D.get_coordinate_y()
      • Wavefront2D.get_intensity()
      • Wavefront2D.get_interpolated()
      • Wavefront2D.get_interpolated_amplitude()
      • Wavefront2D.get_interpolated_amplitudes()
      • Wavefront2D.get_interpolated_complex_amplitude()
      • Wavefront2D.get_interpolated_complex_amplitudes()
      • Wavefront2D.get_interpolated_intensities()
      • Wavefront2D.get_interpolated_intensity()
      • Wavefront2D.get_interpolated_phase()
      • Wavefront2D.get_interpolated_phases()
      • Wavefront2D.get_mask_grid()
      • Wavefront2D.get_mesh_indices_x()
      • Wavefront2D.get_mesh_indices_y()
      • Wavefront2D.get_mesh_x()
      • Wavefront2D.get_mesh_y()
      • Wavefront2D.get_phase()
      • Wavefront2D.get_photon_energy()
      • Wavefront2D.get_wavelength()
      • Wavefront2D.get_wavenumber()
      • Wavefront2D.initialize_wavefront()
      • Wavefront2D.initialize_wavefront_from_arrays()
      • Wavefront2D.initialize_wavefront_from_range()
      • Wavefront2D.initialize_wavefront_from_steps()
      • Wavefront2D.is_polarized()
      • Wavefront2D.offset()
      • Wavefront2D.rebin()
      • Wavefront2D.rescale_amplitude()
      • Wavefront2D.rescale_amplitudes()
      • Wavefront2D.set_complex_amplitude()
      • Wavefront2D.set_photon_energy()
      • Wavefront2D.set_plane_wave_from_amplitude_and_phase()
      • Wavefront2D.set_plane_wave_from_complex_amplitude()
      • Wavefront2D.set_spherical_wave()
      • Wavefront2D.set_wavelength()
      • Wavefront2D.set_wavenumber()
      • Wavefront2D.size()
      • Wavefront2D.wavelength
    • test_initializers()
    • test_interpolator()
    • test_plane_wave()
    • test_polarization()
    • test_polarization_interpolation()
  • Module contents

Submodules

srxraylib.version module

Auto-generated version information for srxraylib.

Module contents

class srxraylib.DeprecatedClassMeta(name, bases, classdict, *args, **kwargs)

Bases: type

srxraylib.deprecated(reason)