finesse.simulations.base module

class finesse.simulations.base.ModelSettings[source]

Bases: object

A class used to represent the settings of a model.

Attributes

phase_configPhaseConfig: The configuration of the phase.
homs_viewndarray: A view on the higher order modes (HOMs).
max_nint: The maximum n value in the HOMs.
max_mint: The maximum m value in the HOMs.
num_HOMsint: The number of HOMs.
lambda0float: The wavelength.
f0float: The frequency, calculated as the speed of light divided by the wavelength.
k0float: The wave number, calculated as 2*pi divided by the wavelength.

Methods

__reduce__(): Returns a tuple that can be used to rebuild the object using rebuild_model_settings.
set_lambda0(value): Sets the wavelength and updates the frequency and wave number accordingly.

EPSILON0_C: EPSILON0_C: ‘double’

UNIT_VACUUM: UNIT_VACUUM: ‘double’

f0: f0: ‘double’

fsig: fsig: ‘double’

homs[source]

Returns a view on the higher order modes (HOMs).

Returns

ndarray: A view on the HOMs.

homs_view: homs_view: ‘int[:, ::1]’

is_modal: is_modal: ‘bool’

k0: k0: ‘double’

lambda0: lambda0: ‘double’

max_m: max_m: ‘int’

max_n: max_n: ‘int’

num_HOMs: num_HOMs: ‘int’

phase_config: phase_config: finesse.simulations.base.PhaseConfig

set_lambda0(self, value)[source]

Sets the wavelength and updates the frequency and wave number accordingly.

Parameters

valuefloat: The new wavelength.

x_scale: x_scale: ‘double’

class finesse.simulations.base.PhaseConfig[source]

Bases: object

v2_transmission_phase: v2_transmission_phase: ‘bool’

zero_k00: zero_k00: ‘bool’

zero_tem00_gouy: zero_tem00_gouy: ‘bool’

finesse.simulations.base.rebuild_model_settings(d)[source]

Rebuilds the model settings from a dictionary.

Parameters

ddict: A dictionary where each key-value pair represents a setting name and its value.

Returns

ModelSettings: A new ModelSettings object with its attributes set according to d.