finesse.analysis.actions.Sweep

Overview

class finesse.analysis.actions.Sweep(*args, pre_step=None, post_step=None, reset_parameter=True, name='step')[source]

Bases: finesse.analysis.actions.Action

An action that sweeps N number of parameters through the values in N arrays.

Parameters

args : [Parameter, str], array, boolean

Expects 3 arguments per axis. The first is a full name of a Parameter or a Parameter object. The second is an array of values to step this parameter over, and lastly a boolean value to say whether this is a relative step from the parameters initial value.

pre_step : Action, optional

An action to perform before the step is computed

post_step : Action, optional

An action to perform after the step is computed

reset_parameter : boolean, optional

When true this action will reset the all the parameters it changed to the values before it ran.

name : str

Name of the action, used to find the solution in the final output.