Initial guess

class ChannelGuessParameters

ChannelGuessParameters defines the guessed gain and the functional form of the input_power evolution for each type of channel (signal, pump, ASE, and Raman). The gain can be defined directly or as the output input_power. The gain guess is stored as a function used to calculate the output input_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 input_power.

Returns

The guessed output input_power

Return type

float

set_gain_db(gain_db)

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

Parameters

gain_db (float) – Guessed total gain in dB

set_gain_shape(gain_shape)

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

Parameters

gain_shape (Member of GainShapes Enum) – New guess for the functional form of input_power evolution

set_output_power(output_power)

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

Parameters

output_power (float) – Guessed output input_power in W

class GainShapes(value)

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

class GuessParameters

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