route_manhattan

photonforge.parametric.route_manhattan(*, terminal1=None, terminal2=None, direction1=None, direction2=None, layer=None, width=None, overlap_fraction=None, join_limit=None, waypoints=None, technology=None, name=None)[source]

Create a Manhattan path connecting 2 terminals.

Parameters:

  • terminal1 (Annotated[Terminal | tuple[Reference, str] | tuple[Reference, str, int], _Metadata(type=Terminal, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – First terminal to be connected. The terminal can be specified as a photonforge.Terminal or as a tuple including a photonforge.Reference, the terminal name, and the repetition index (optional, only for array references).

  • terminal2 (Annotated[Terminal | tuple[Reference, str] | tuple[Reference, str, int], _Metadata(type=Terminal, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Second terminal to be connected.

  • direction1 (Annotated[Literal['', 'x', 'y'], ~photonforge.parametric._Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Direction (“”, “x”, or “y”) of the route at the first terminal.

  • direction2 (Annotated[Literal['', 'x', 'y'], ~photonforge.parametric._Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Direction (“”, “x”, or “y”) of the route at the second terminal.

  • layer (Annotated[str | tuple[int, int], _Metadata(type=Layer, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Layer used for the connection. If None, the routing layer of the first terminal is used.

  • width (Annotated[float, _Metadata(type=None, title=None, description=None, units=μm, required=False, minimum=None, maximum=None, exclusive_minimum=0, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Width of the routing path. If None, the width is derived from the bounding box of the first terminal.

  • overlap_fraction (Annotated[Annotated[float, _Metadata(type=None, title=None, description=None, units=None, required=False, minimum=0, maximum=1, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | Annotated[Sequence[Annotated[float, _Metadata(type=None, title=None, description=None, units=None, required=False, minimum=0, maximum=1, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)]], _Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=2, max_items=2)], _Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Fraction of the terminal bounding box that the route overlaps. If None, defaults to 1.

  • join_limit (Annotated[Literal['round'] | float, ~photonforge.parametric._Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Join limit used by photonforge.Path.segment(). If None defaults to -1.

  • waypoints (Annotated[Sequence[Annotated[Sequence[Annotated[float, _Metadata(type=None, title=None, description=None, units=μm, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)]], _Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=2, max_items=2)]], _Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Sequence of coordinates the route should go through.

  • technology (Annotated[Technology, _Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Component technology. If None, the default technology is used.

  • name (Annotated[str, _Metadata(type=None, title=None, description=None, units=None, required=False, minimum=None, maximum=None, exclusive_minimum=None, exclusive_maximum=None, min_items=None, max_items=None)] | None) – Component name.

Returns:

Component with the route.

terminal1 = pf.Terminal("METAL", pf.Rectangle((10, 10)))
terminal2 = pf.Terminal("METAL", pf.Rectangle(center=(180, -70), size=(10, 10)))
component = route_manhattan(
    terminal1=terminal1, direction1="x", terminal2=terminal2, waypoints=[(90, 50)]
)
route_manhattan