finesse.components.general

Top-level objects which specific optical, and otherwise, components should inherit from.

Classes

Connector(name)

Base class for any component which connects nodes together.

FrequencyGenerator()

The base class for components which generate optical frequencies.

NoiseGenerator()

The base class for components which generate some kind of noise.

Variable(name, value)

Enums

CouplingType(value)

An enum describing the type of coupling between two nodes.

InteractionType(value)

An enum describing the type of interaction between two nodes.

NoiseType(value)

An enum describing the type of noise a component generates.

Functions

borrows_nodes()

Flags that a ModelElement will be making references to nodes owner by other elements, or borrows a reference.

determine_coupling_type(from_node, to_node)

Retrieves the type of coupling (see CouplingType) between two nodes.