Initial guess

class GuessParameters

GuessParameters defines the guessed gain and functional form of each channel in the simulation. See also docs for ChannelGuessParameters

class ChannelGuessParameters

ChannelGuessParameters defines the guessed gain and the functional form of the power evolution for each type of channel (signal, pump, ASE, and Raman). The gain can be defined directly or as the output power. The gain guess is stored as a function used to calculate the output power.

get_gain_shape()

Getter for the guessed shape of the function.

Returns:The guessed functional form Return type:Member of the GainShapes Enum

get_output_power(input_power)

Getter for the guessed output power.

Returns:The guessed output power Return type:float

set_gain_db(gain_db)

Set new guessed gain value. Overrides default and previously set gain and output power guesses.

Parameters:gain_db (float) – Guessed total gain in dB

set_gain_shape(gain_shape)

Set new guessed shape of the power evolution. Overrides default or previously set values.

Parameters:gain_shape (Member of GainShapes Enum) – New guess for the functional form of power evolution

set_output_power(output_power)

Set new guessed output power value. Overrides default and previously set gain and output power guesses.

Parameters:output_power (float) – Guessed output power in W

class GainShapes

This Enum defines the possible functional forms used the construct the initial guess.