zospy.analyses.physicaloptics.physical_optics_propagation.create_beam_parameter_dict

zospy.analyses.physicaloptics.physical_optics_propagation.create_beam_parameter_dict(oss: OpticStudioSystem, beam_type: constants.Analysis.PhysicalOptics.POPBeamTypes | str = 'GaussianWaist') → dict

Create a dictionary containing the parameters for a certain Physical Optics beam type and their default values.

The dictionary can be adjusted and supplied to the beam_parameters argument of physical_optics_propagation()

Parameters:

osszospy.zpcore.OpticStudioSystem

A ZOSPy OpticStudioSystem instance. Should be sequential.

beam_typeconstants.Analysis.PhysicalOptics.POPBeamTypes | str

The beam type. Defaults to ‘GaussianWaist’.

Returns:

dict

A dictionary containing the parameters for a certain Physical Optics beam type and their default values.