Sources#

class PlaneWave(amplitude, wavelength, polarization)[source]#

Bases: BaseSource, Sequential

Represents a Plane Wave light source with a specified amplitude.

Inherits from BaseSource and specifies amplitude directly.

Parameters:

  • wavelength (Quantity) – The wavelength(s) of the light source.

  • polarization (Union[UnitPolarizationAngle, Quantity]) – Polarization state of the light field, if float is given it is assumed Linear polarization of angle theta.

  • amplitude (Quantity) – The amplitude of the plane wave, in Volt/Meter.

amplitude: Quantity#
classmethod build_sequential(total_size=None, **kwargs)#

Broadcast scalar or single-element parameters to NumPy arrays of uniform length and construct a new instance of the class.

Each parameter passed via keyword arguments may be provided as a scalar or as a list/array. Scalars or single-element lists/arrays will be repeated to match the length of the longest parameter. If any parameter is given as a list/array with more than one element, its length must equal the maximum length among all parameters (or the explicit total_size if provided); otherwise, a ValueError is raised.

Additionally, if a keyword argument ‘source’ is provided, it is removed from the broadcasted parameters and passed directly to the class constructor.

Parameters:

  • total_size (int, optional) – The explicit target size for broadcasting. Must be a positive integer if provided. If not specified, the target size is determined by the maximum size among the input parameters.

  • **kwargs (dict) – Arbitrary keyword arguments mapping parameter names to values. Each value may be a scalar or a list/array of values. Examples include parameters such as source, diameter, property, or medium_property.

Returns:

A new instance of the class with all provided parameters broadcasted as NumPy arrays of equal length. If ‘source’ is provided, it is passed directly to the class constructor.

Return type:

object

Raises:

ValueError – If any parameter provided as a list/array has a length greater than one that does not match the target size.

is_sequential = False#
polarization: BasePolarization | Quantity#
wavelength: Quantity#
class Gaussian(NA, optical_power, wavelength, polarization)[source]#

Bases: BaseSource, Sequential

Represents a Gaussian light source with a specified numerical aperture and optical power.

Inherits from BaseSource and adds specific attributes for Gaussian sources.

Parameters:

  • wavelength (Quantity) – The wavelength(s) of the light source.

  • polarization (Union[UnitPolarizationAngle, Quantity]) – Polarization state of the light field, if float is given it is assumed Linear polarization of angle theta.

  • NA (Quantity) – The numerical aperture(s) of the Gaussian source.

  • optical_power (Quantity) – The optical power of the source, in Watts.

NA: Quantity#
classmethod build_sequential(total_size=None, **kwargs)#

Broadcast scalar or single-element parameters to NumPy arrays of uniform length and construct a new instance of the class.

Each parameter passed via keyword arguments may be provided as a scalar or as a list/array. Scalars or single-element lists/arrays will be repeated to match the length of the longest parameter. If any parameter is given as a list/array with more than one element, its length must equal the maximum length among all parameters (or the explicit total_size if provided); otherwise, a ValueError is raised.

Additionally, if a keyword argument ‘source’ is provided, it is removed from the broadcasted parameters and passed directly to the class constructor.

Parameters:

  • total_size (int, optional) – The explicit target size for broadcasting. Must be a positive integer if provided. If not specified, the target size is determined by the maximum size among the input parameters.

  • **kwargs (dict) – Arbitrary keyword arguments mapping parameter names to values. Each value may be a scalar or a list/array of values. Examples include parameters such as source, diameter, property, or medium_property.

Returns:

A new instance of the class with all provided parameters broadcasted as NumPy arrays of equal length. If ‘source’ is provided, it is passed directly to the class constructor.

Return type:

object

Raises:

ValueError – If any parameter provided as a list/array has a length greater than one that does not match the target size.

is_sequential = False#
optical_power: Quantity#
polarization: BasePolarization | Quantity#
wavelength: Quantity#