finesse.analysis.axes.xaxis

finesse.analysis.axes.xaxis(param: finesse.parameter.Parameter, mode: str, start: float, stop: float, steps: int, relative: bool = False)

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 xaxis command in Finesse v2.

Parameters

param : Parameter

Parameter of component to scan.

mode : str

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

start, stop : float

Start and end values of the scan.

steps : int

Number of steps between start and end.

relative : float, optional

Changes relative to parameter initial value