from __future__ import annotations
from functools import partial
import numpy as np
import gdsfactory as gf
from gdsfactory.component import Component
from gdsfactory.components.bend_euler import bend_euler
from gdsfactory.components.extension import extend_ports
from gdsfactory.components.straight import straight
from gdsfactory.components.taper import taper
from gdsfactory.components.text import text_rectangular
from gdsfactory.typings import (
ComponentSpec,
ComponentSpecOrList,
CrossSectionSpec,
Float2,
)
edge_coupler_silicon = partial(
taper,
width2=0.2,
length=100,
with_two_ports=True,
port_types=("optical", "edge_te"),
)
edge_coupler_silicon_2 = partial(
taper,
width2=0.2,
length=130,
with_two_ports=True,
port_types=("optical", "edge_te"),
)
[docs]
@gf.cell
def edge_coupler_array(
edge_coupler: ComponentSpec | ComponentSpecOrList = edge_coupler_silicon,
n: int = 5,
pitch: float = 127.0,
x_reflection: bool = False,
text: ComponentSpec | None = text_rectangular,
text_offset: Float2 = (10, 20),
text_rotation: float = 0,
text_mirror: bool = False,
angle: float = 0,
bend: ComponentSpec = bend_euler,
place_x_by_port: bool = True,
space_y_by_port: bool = False,
alignment_port: str = "o1",
) -> Component:
"""Fiber array edge coupler based on an inverse taper.
Each edge coupler adds a ruler for polishing.
Args:
edge_coupler: edge coupler spec or list of edge coupler specs.
n: number of channels. Overwritten if edge_coupler is a list.
pitch: Fiber pitch.
x_reflection: horizontal mirror.
text: text spec.
text_offset: from edge coupler.
text_rotation: text rotation in degrees.
text_mirror: mirrors the text.
angle: rotation in degrees.
bend: bend spec. Used only if angle > 0.
place_x_by_port: If True it aligns the ports in the x direction.
If False it aligns the right edge.
space_y_by_port: If True it spaces the edge couplers based on port.
If False it just places the y of the edge coupler at the given pitch
alignment_port: port that we use to align and space edge couplers
Requires edge coupler waveguide port to face left.
.. code::
┌─────────────────┐
│ │
│ │
─────────────── │ │
─────────────── │ │
o1 edge_coupler_tip│ fiber │
─────────────── │ │
─────────────── │ │
│ │
│ │
└─────────────────┘
"""
if not isinstance(edge_coupler, list):
# Make it a list
edge_coupler = [edge_coupler] * n
else:
n = len(edge_coupler)
c = Component()
for i in range(n):
alias = f"ec_{i}"
edge_coupler_comp = gf.get_component(edge_coupler[i])
ref = c.add_ref(edge_coupler_comp, alias=alias)
ref.rotate(angle)
if x_reflection:
ref.mirror()
if space_y_by_port:
ref.movey(i * pitch - ref.ports[alignment_port].y)
else:
ref.y = i * pitch
if place_x_by_port:
ref.movex(-ref.ports[alignment_port].x)
else:
ref.xmax = 0
if angle:
# straighten the port to a manhattan 180 degree angle to avoid grid errors
b = c << bend(angle=angle)
b.connect("o2", ref.ports["o1"])
c.add_port(f"o{i}", port=b["o1"])
else:
for port in ref.get_ports_list():
c.add_port(f"{port.name}_{i}", port=port)
if text:
t = c << gf.get_component(text, text=str(i + 1))
t.rotate(text_rotation)
t.move(np.array(text_offset) + (ref.ports[alignment_port].x, i * pitch))
if text_mirror:
t.mirror()
if angle:
c = c.flatten_offgrid_references()
c.auto_rename_ports()
return c
[docs]
@gf.cell
def edge_coupler_array_with_loopback(
edge_coupler: ComponentSpec | ComponentSpecOrList = edge_coupler_silicon,
cross_section: CrossSectionSpec | None = "xs_sc",
radius: float = 30,
n: int = 8,
pitch: float = 127.0,
extension_length: float = 1.0,
right_loopback: bool = True,
x_reflection: bool = False,
text: ComponentSpec | None = text_rectangular,
text_offset: Float2 = (0, 0),
text_rotation: float = 0,
text_mirror: bool = False,
bend: ComponentSpec = bend_euler,
straight: ComponentSpec = straight,
taper: ComponentSpec | None = None,
angle: float = 0,
place_x_by_port: bool = True,
space_y_by_port: bool = False,
alignment_port: str = "o1",
) -> Component:
"""Fiber array edge coupler.
Args:
edge_coupler: edge coupler.
cross_section: spec.
radius: bend radius loopback (um).
n: number of channels.
pitch: Fiber pitch (um).
extension_length: in um.
right_loopback: adds right loopback.
x_reflection: horizontal mirror.
text: Optional text spec.
text_offset: x, y.
text_rotation: text rotation in degrees.
text_mirror: mirrors the text.
bend: bend spec.
straight: straight spec.
taper: taper spec.
angle: rotation in degrees.
"""
c = Component()
ec = edge_coupler_array(
edge_coupler=edge_coupler,
n=n,
pitch=pitch,
x_reflection=x_reflection,
text=text,
text_offset=text_offset,
text_rotation=text_rotation,
text_mirror=text_mirror,
angle=angle,
bend=bend,
place_x_by_port=place_x_by_port,
space_y_by_port=space_y_by_port,
alignment_port=alignment_port,
)
if extension_length > 0:
ec = extend_ports(
component=ec,
port_names=("o1", "o2"),
length=extension_length,
extension=partial(
gf.c.straight, cross_section=cross_section, length=extension_length
)
if cross_section
else straight,
)
ec_ref = c << ec
route1 = gf.routing.get_route(
ec_ref.ports["o1"],
ec_ref.ports["o2"],
bend=bend,
straight=straight,
taper=taper,
cross_section=cross_section,
radius=radius,
)
c.add(route1.references)
# Override n if it's a list of edge couplers
if isinstance(edge_coupler, list):
n = len(edge_coupler)
if n > 4 and right_loopback:
route2 = gf.routing.get_route(
ec_ref.ports[f"o{n-1}"],
ec_ref.ports[f"o{n}"],
bend=bend,
straight=straight,
taper=taper,
cross_section=cross_section,
radius=radius,
)
c.add(route2.references)
for i in range(n - 4):
c.add_port(str(i), port=ec_ref.ports[f"o{i+3}"])
elif n > 4:
for i in range(n - 2):
c.add_port(str(i), port=ec_ref.ports[f"o{i+3}"])
c.auto_rename_ports()
return c
if __name__ == "__main__":
gf.config.enable_offgrid_ports()
# c = edge_coupler_array_with_loopback(text_rotation=90)
# c = edge_coupler_silicon()
# c = edge_coupler_array(x_reflection=False)
# c = edge_coupler_array_with_loopback(x_reflection=False)
# c = edge_coupler_array(angle=8)
c = edge_coupler_array(
edge_coupler=[
edge_coupler_silicon,
edge_coupler_silicon_2,
edge_coupler_silicon_2,
edge_coupler_silicon,
],
angle=8,
place_x_by_port=True,
space_y_by_port=True,
alignment_port="o2",
)
# c = edge_coupler_array_with_loopback(
# edge_coupler=[
# edge_coupler_silicon,
# edge_coupler_silicon_2,
# edge_coupler_silicon_2,
# edge_coupler_silicon,
# ],
# angle=0,
# place_by_port=False,
# )
c.show(show_ports=True)
