route_z

photonforge.parametric.route_z(*, port1=None, port2=None, radius=None, alignment=None, padding=None, pitch=None, bend=None, straight_kwargs=None, s_bend_kwargs=None, technology=None, name=None, route_model=None, bundle_model=None)[source]

Route the connection between parallel ports.

Parameters:

  • port1 (Port | tuple[Reference, str] | tuple[Reference, str, int] | Sequence[Port | tuple[Reference, str] | tuple[Reference, str, int]] | None) – First port to be connected. The port can be specified as a photonforge.Port or as a tuple including a photonforge.Reference, the port name, and the repetition index (optional, only for array references). A sequence of ports can be used for bundle routing.

  • port2 (Port | tuple[Reference, str] | tuple[Reference, str, int] | Sequence[Port | tuple[Reference, str] | tuple[Reference, str, int]] | None) – Second port to be connected. A sequence of ports can be used for bundle routing (with same length as port1).

  • radius (Annotated[float, exclusiveMinimum=0, units='μm'] | None) – Radius used for bends, if needed.

  • alignment (Literal['center', 'port1', 'port2'] | None) – Alignment of the transversal route section. One of "center", "port1", or "port2". If None, defaults to "center".

  • padding (Annotated[float, minimum=0, units='μm'] | Annotated[Sequence[Annotated[float, minimum=0, units='μm']], maxItems=2, minItems=2] | None) – Minimal straight length added before bends. Use 2 values to set different paddings for ports 1 and 2. Affects alignment.

  • pitch (Annotated[float, minimum=0, units='μm'] | None) – Center-to-center distance between adjacent waveguides in a bundle. If None, the largest snapped port width is used.

  • bend (Component | Sequence[Component] | None) – 90° bend to be used for routing. If the bundle has different port specifications, a sequence of bends (one for each specification) must be provided. If None, the default parametric bend will be used.

  • straight_kwargs (Annotated[dict[str, Any], _] | None) – Keyword arguments for straight().

  • s_bend_kwargs (Annotated[dict[str, Any], _] | None) – Keyword arguments for s_bend().

  • technology (Technology | None) – Component technology. If None, the default technology is used.

  • name (str | None) – Component name.

  • route_model (Model | None) – Model to be used with each route sub-component. If None a photonforge.CircuitModel is used.

  • bundle_model (Model | None) – Model to be used with the top-level route component. If None a photonforge.CircuitModel is used.

Returns:

Component with the route, including ports and model.

Return type:

Component

ports1 = [
    pf.Port((0, 0), 180, "Strip"),
    pf.Port((0, 12), 180, "Strip"),
    pf.Port((0, 30), 180, "Rib"),
    pf.Port((0, 55), 180, "Strip"),
    pf.Port((0, 60), 180, "Rib"),
    pf.Port((0, 90), 180, "Strip"),
    pf.Port((0, 95), 180, "Strip"),
]

ports2 = [
    pf.Port((100, 25), 0, "Strip"),
    pf.Port((100, 30), 0, "Strip"),
    pf.Port((100, 34), 0, "Rib"),
    pf.Port((100, 38), 0, "Strip"),
    pf.Port((100, 60), 0, "Rib"),
    pf.Port((100, 65), 0, "Strip"),
    pf.Port((100, 70), 0, "Strip"),
]

component = pf.parametric.route_z(port1=ports1, port2=ports2, pitch=5, radius=10)
route_z