finesse.analysis.actions.operator.Operator

Overview

class finesse.analysis.actions.operator.Operator(start_node, end_node, via=None, frequency=0, *, name='operator')

Bases: Action

This action can be used to extract operators out from a simulation for external use. The operators are defined by a path in the network between two nodes (via some other if more direction is required).

The model.path method can be used to test which nodes are traversed before using this to extract operators if needed.

Parameters

start_nodestr

Start node name

end_nodestr

End node name

viastr, optional

Via node to use to specify a path with multiple options

frequencyfloat, optional

Optical carrier or signal frequency to use for calculating the operators

namestr, optional

Name of the solution generated by this action