wofry.propagator package

Subpackages

• wofry.propagator.util package
  • Submodules
  • wofry.propagator.util.gaussian_schell_model module
    • GaussianSchellModel1D
      • GaussianSchellModel1D.S()
      • GaussianSchellModel1D.a()
      • GaussianSchellModel1D.b()
      • GaussianSchellModel1D.beta()
      • GaussianSchellModel1D.c()
      • GaussianSchellModel1D.evaluate()
      • GaussianSchellModel1D.g()
      • GaussianSchellModel1D.phi()
    • GaussianSchellModel2D
      • GaussianSchellModel2D.beta()
      • GaussianSchellModel2D.evaluate()
      • GaussianSchellModel2D.phi()
      • GaussianSchellModel2D.phi_nm()
      • GaussianSchellModel2D.sortedModeIndices()
  • Module contents
• wofry.propagator.wavefront1D package
  • Submodules
  • wofry.propagator.wavefront1D.generic_wavefront module
    • GenericWavefront1D
      • GenericWavefront1D.add_phase_shift()
      • GenericWavefront1D.add_phase_shifts()
      • GenericWavefront1D.clip()
      • GenericWavefront1D.delta()
      • GenericWavefront1D.duplicate()
      • GenericWavefront1D.get_abscissas()
      • GenericWavefront1D.get_amplitude()
      • GenericWavefront1D.get_complex_amplitude()
      • GenericWavefront1D.get_dimension()
      • GenericWavefront1D.get_integrated_intensity()
      • GenericWavefront1D.get_intensity()
      • GenericWavefront1D.get_interpolated_amplitude()
      • GenericWavefront1D.get_interpolated_amplitudes()
      • GenericWavefront1D.get_interpolated_complex_amplitude()
      • GenericWavefront1D.get_interpolated_complex_amplitudes()
      • GenericWavefront1D.get_interpolated_intensities()
      • GenericWavefront1D.get_interpolated_intensity()
      • GenericWavefront1D.get_interpolated_phase()
      • GenericWavefront1D.get_interpolated_phases()
      • GenericWavefront1D.get_mesh_x()
      • GenericWavefront1D.get_phase()
      • GenericWavefront1D.get_photon_energy()
      • GenericWavefront1D.get_wavelength()
      • GenericWavefront1D.get_wavenumber()
      • GenericWavefront1D.guess_wavefront_curvature()
      • GenericWavefront1D.initialize_wavefront()
      • GenericWavefront1D.initialize_wavefront_from_arrays()
      • GenericWavefront1D.initialize_wavefront_from_range()
      • GenericWavefront1D.initialize_wavefront_from_steps()
      • GenericWavefront1D.is_identical()
      • GenericWavefront1D.is_polarized()
      • GenericWavefront1D.load_h5_file()
      • GenericWavefront1D.offset()
      • GenericWavefront1D.rescale_amplitude()
      • GenericWavefront1D.rescale_amplitudes()
      • GenericWavefront1D.save_h5_file()
      • GenericWavefront1D.scan_wavefront_curvature()
      • GenericWavefront1D.set_complex_amplitude()
      • GenericWavefront1D.set_gaussian()
      • GenericWavefront1D.set_gaussian_hermite_mode()
      • GenericWavefront1D.set_photon_energy()
      • GenericWavefront1D.set_pi_complex_amplitude_to_zero()
      • GenericWavefront1D.set_plane_wave_from_amplitude_and_phase()
      • GenericWavefront1D.set_plane_wave_from_complex_amplitude()
      • GenericWavefront1D.set_spherical_wave()
      • GenericWavefront1D.set_wavelength()
      • GenericWavefront1D.set_wavenumber()
      • GenericWavefront1D.size()
  • Module contents
• wofry.propagator.wavefront2D package
  • Submodules
  • wofry.propagator.wavefront2D.generic_wavefront module
  • Module contents

Submodules

wofry.propagator.decorators module

Abstract decorator classes for wofry wavefront propagators.

class wofry.propagator.decorators.WavefrontDecorator

Bases: object

classmethod fromGenericWavefront(wavefront)

get_dimension()

toGenericWavefront()

wofry.propagator.polarization module

Polarization state constants for wofry wavefronts (SIGMA, PI, TOTAL).

class wofry.propagator.polarization.Polarization

Bases: object

PI = 1

SIGMA = 0

TOTAL = 3

wofry.propagator.propagator module

Core wofry propagator infrastructure: Propagator, PropagationManager, and PropagationParameters.

class wofry.propagator.propagator.AbstractPropagator

Bases: object

do_propagation(parameters=<wofry.propagator.propagator.PropagationParameters object>)

get_dimension()

get_handler_name()

is_handler(handler_name)

class wofry.propagator.propagator.PropagationApplication

Bases: object

ALL = 'All'

class wofry.propagator.propagator.PropagationElements

Bases: object

INSERT_AFTER = 0

INSERT_BEFORE = 1

add_beamline_element(beamline_element=<syned.beamline.beamline_element.BeamlineElement object>, element_parameters=None)

add_beamline_elements(beamline_elements=[], element_parameters_list=None)

get_propagation_element(index)

get_propagation_element_parameter(index)

get_propagation_elements()

get_propagation_elements_number()

get_propagation_elements_parameters()

insert_beamline_element(index, new_element=<syned.beamline.beamline_element.BeamlineElement object>, mode=1, new_element_parameters=None)

class wofry.propagator.propagator.PropagationMode

Bases: object

STEP_BY_STEP = 0

WHOLE_BEAMLINE = 1

class wofry.propagator.propagator.PropagationParameters(wavefront=<wofry.propagator.wavefront.Wavefront object>, propagation_elements=<wofry.propagator.propagator.PropagationElements object>, **additional_parameters)

Bases: object

get_PropagationElements()

get_additional_parameter(key)

get_wavefront()

has_additional_parameter(key)

set_additional_parameters(key, value)

class wofry.propagator.propagator.Propagator

Bases: AbstractPropagator

do_propagation(parameters=<wofry.propagator.propagator.PropagationParameters object>)

do_specific_progation_after(wavefront, propagation_distance, parameters, element_index=None)

do_specific_progation_before(wavefront, propagation_distance, parameters, element_index=None)

get_additional_parameter(parameter_name, default_value, propagation_parameters, element_index=None)

class wofry.propagator.propagator.Propagator1D

Bases: Propagator

do_propagation(parameters=<wofry.propagator.propagator.PropagationParameters object>)

get_dimension()

class wofry.propagator.propagator.Propagator2D

Bases: Propagator

do_propagation(parameters=<wofry.propagator.propagator.PropagationParameters object>)

get_dimension()

wofry.propagator.wavefront module

Abstract base classes for wofry wavefronts (Wavefront, WavefrontDimension).

class wofry.propagator.wavefront.Wavefront

Bases: object

Abstract base class for all wofry wavefronts.

Concrete subclasses must implement get_dimension() and duplicate(). Serialisation to/from a hex string is provided via pickle.

duplicate()

Return a deep copy of this wavefront.

classmethod from_hex_tring(hex_string)

Deserialise a wavefront from a hex string produced by to_hex_tring().

Parameters:

hex_string (str) – Hex-encoded pickle bytes.

Returns:

Reconstructed wavefront instance.

Return type:

Wavefront

get_dimension()

Return the wavefront dimension (‘1’ or ‘2’).

Returns:

WavefrontDimension.ONE or WavefrontDimension.TWO.

Return type:

str

to_hex_tring()

Serialise the wavefront to a hex string via pickle.

Returns:

Hex-encoded pickle bytes.

Return type:

str

class wofry.propagator.wavefront.WavefrontDimension

Bases: object

Constants identifying the spatial dimension of a wavefront.

ONE = '1'

TWO = '2'

Module contents