finesse.analysis.axes.x3axis

finesse.analysis.axes.x3axis(param1, mode1, start1, stop1, steps1, param2, mode2, start2, stop2, steps2, param3, mode3, start3, stop3, steps3, relative=False, **kwargs)

Runs a model to scan a parameter between two points for a number of steps. The model that is run is retrieved from the parameter reference.

This should provide an equivalent to the x3axis command in Finesse v2.

Parameters

param1, param2, param3 : Parameter

Parameter of component to scan.

mode1, mode2, mode3 : str

‘lin’ or ‘log’ for linear or logarithmic step sizes for each axis.

start1, stop1, start2, stop2, start3, stop3 : float

Start and end values of the scan.

steps1, steps2, steps3 : int

Number of steps between start and end.

relative : float, optional

Changes relative to parameter initial value

Notes

param3 is in the inner loop and param1 in the outer loop.