Source code for gdsfactory.components.array_component
from __future__ import annotations
import gdsfactory as gf
from gdsfactory.cell import cell_with_child
from gdsfactory.component import Component
from gdsfactory.typings import ComponentSpec, Float2
[docs]
@cell_with_child
def array(
component: ComponentSpec = "pad",
spacing: tuple[float, float] = (150.0, 150.0),
columns: int = 6,
rows: int = 1,
add_ports: bool = True,
size: Float2 | None = None,
centered: bool = False,
) -> Component:
"""Returns an array of components.
Args:
component: to replicate.
spacing: x, y spacing.
columns: in x.
rows: in y.
add_ports: add ports from component into the array.
size: Optional x, y size. Overrides columns and rows.
centered: center the array around the origin.
Raises:
ValueError: If columns > 1 and spacing[0] = 0.
ValueError: If rows > 1 and spacing[1] = 0.
.. code::
2 rows x 4 columns
___ ___ ___ ___
| | | | | | | |
|___| |___| |___| |___|
___ ___ ___ ___
| | | | | | | |
|___| |___| |___| |___|
"""
if size:
columns = int(size[0] / spacing[0])
rows = int(size[1] / spacing[1])
if rows > 1 and spacing[1] == 0:
raise ValueError(f"rows = {rows} > 1 require spacing[1] > 0")
if columns > 1 and spacing[0] == 0:
raise ValueError(f"columns = {columns} > 1 require spacing[0] > 0")
c = Component()
component = gf.get_component(component)
ref = c.add_array(component, columns=columns, rows=rows, spacing=spacing)
old_center = ref.center
ref.center = (0, 0) if centered else old_center
center_shift = ref.center - old_center
if add_ports and ref.ports:
for col in range(int(columns)):
for row in range(int(rows)):
for port in component.ports.values():
name = f"{port.name}_{row+1}_{col+1}"
c.add_port(name, port=port)
c.ports[name].move(
(col * spacing[0], row * spacing[1]) + center_shift
)
c.copy_child_info(component)
return c
if __name__ == "__main__":
from gdsfactory.generic_tech import get_generic_pdk
PDK = get_generic_pdk()
PDK.activate()
from gdsfactory.components.pad import pad
# c2 = array(rows=2, columns=2, spacing=(100, 100))
# c2 = array(pad, rows=2, spacing=(200, 200), columns=1)
# c3 = c2.copy()
c2 = array(pad, spacing=(200, 200), size=(700, 300), centered=True, columns=3)
# nports = len(c2.get_ports_list(orientation=0))
# assert nports == 2, nports
# c2.show(show_ports=True)
# c2.show(show_subports=True)
c2.show(show_ports=True)
