finesse.model.Model.merge

Model.merge(other, from_comp, from_port, to_comp, to_port, name=None, L=0, nr=1)[source]

Merges the model other with this model using a connection at the specified ports.

Note

Upon completion of this method call the Model instance other will be invalidated. All components and nodes within other will be associated with only this model.

Parameters

other : Model

A model configuration to merge into this model instance.

from_comp : Sub-class of Connector

The component to start a connection from.

from_port : int

Port of from_comp to initiate the connection from.

to_comp : Sub-class of Connector

The component to bridge the connection to.

to_port : int

Port of to_comp to bridge the connection to.

name : str

Name of connecting Space instance.

L : float

Length of the connecting space.

nr : float

Index of refraction of the connecting space.