Connectors

Space

space
s
Space

Represents a space between two components in the interferometer configuration, with a given length and index of refraction.

There can be many spaces in a model which are not of much interest and do not need to be referred to. For example, the link command will create spaces between components without giving an explicit name, just specifying a distance between them. All Space elements are added to the Model’s .spaces namespace so they can all easily be iterated over. You can also find spaces which had no name specified and thus have an autogenerated name. User specified Space’s with names will be put in the main Model namespace so that they can be accessed like any other element in the model.

Syntax
s name portA portB L=0.0 nr=1.0 user_gouy_x=none user_gouy_y=none
Required

portA, portB: Ports to connect.

Optional

name: Name of newly created space. If not specified, a name is automatically generated.

L: Geometric length of newly created Space instance; defaults to 0.

nr: Index of refraction of newly created Space instance; defaults to 1.0.

user_gouy_x, user_gouy_y: User-defined gouy phase to override the calculated value.

Nothing

nothing
Nothing

Represents an empty point in the interferometer configuration.

Nothing is just some point in space that can be connected to. For example, you can use this to propagate a beam from some component out to some arbitrary point to make a measurement at. You can also use this to split spaces up, if you wanted to measure something inbetween two components. It can also be used to replace a component, for example if you want to remove a lens or a mirror in some beam path.

Syntax
nothing name
Required

name: Name of newly created nothing.

Wire

wire
w
Wire

A wire represents a flow of information between signal nodes. It connects two specific signal nodes. Signal nodes have a direction associated with them: input, output, or bidirectional. Depending on what direction each node has depends on what the wire will setup when it is connected. When connecting ports the wire will look at the name of each node in the port and connect nodes with the same name.

Syntax
w name nodeA nodeB delay=0 gain=1
Required

nodeA, nodeB: Signal nodes to connect together.

Optional

name: Name of newly created wire.

delay: A delay time for the signal to flow from A to B in seconds

gain: An scaling factor that can be used to scale the output relative to the input.