Skip to content

Euler

euler

Euler bends.

Euler bends are bends with a constantly changing radius from zero to a maximum radius and back to 0 at the other end.

There are two kinds of euler bends. One that snaps the ports and one that doesn't. All the default bends use snapping. To use no snapping make an instance of BendEulerCustom(KCell.kcl) and use that one.

BendEulerFactory

Bases: Protocol[KC_co]

Source code in kfactory/factories/euler.py
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
class BendEulerFactory(Protocol[KC_co]):
    def __call__(
        self,
        *,
        radius: um,
        angle: deg = 90,
        resolution: float = 150,
        cross_section: str
        | AnyCrossSectionInput
        | CrossSectionSpecDict
        | DCrossSectionSpecDict
        | None = None,
        width: um | None = None,
        layer: kdb.LayerInfo | None = None,
        enclosure: LayerEnclosure | None = None,
    ) -> KC_co:
        """Create a euler bend.

        Either pass a ``cross_section`` or the legacy ``width``/``layer``/``enclosure``.

        Args:
            radius: Radius off the backbone. [um]
            angle: Angle of the bend.
            resolution: Angle resolution for the backbone.
            cross_section: Cross section of the bend.
            width: Width of the core. [um] (legacy; requires ``layer``)
            layer: Main layer of the bend. (legacy)
            enclosure: Slab/exclude definition. (legacy)
        """
        ...

__call__

__call__(
    *,
    radius: um,
    angle: deg = 90,
    resolution: float = 150,
    cross_section: str
    | AnyCrossSectionInput
    | CrossSectionSpecDict
    | DCrossSectionSpecDict
    | None = None,
    width: um | None = None,
    layer: LayerInfo | None = None,
    enclosure: LayerEnclosure | None = None,
) -> KC_co

Create a euler bend.

Either pass a cross_section or the legacy width/layer/enclosure.

Parameters:

Name Type Description Default
radius um

Radius off the backbone. [um]

required
angle deg

Angle of the bend.

90
resolution float

Angle resolution for the backbone.

150
cross_section str | AnyCrossSectionInput | CrossSectionSpecDict | DCrossSectionSpecDict | None

Cross section of the bend.

None
width um | None

Width of the core. [um] (legacy; requires layer)

None
layer LayerInfo | None

Main layer of the bend. (legacy)

None
enclosure LayerEnclosure | None

Slab/exclude definition. (legacy)

None
Source code in kfactory/factories/euler.py
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def __call__(
    self,
    *,
    radius: um,
    angle: deg = 90,
    resolution: float = 150,
    cross_section: str
    | AnyCrossSectionInput
    | CrossSectionSpecDict
    | DCrossSectionSpecDict
    | None = None,
    width: um | None = None,
    layer: kdb.LayerInfo | None = None,
    enclosure: LayerEnclosure | None = None,
) -> KC_co:
    """Create a euler bend.

    Either pass a ``cross_section`` or the legacy ``width``/``layer``/``enclosure``.

    Args:
        radius: Radius off the backbone. [um]
        angle: Angle of the bend.
        resolution: Angle resolution for the backbone.
        cross_section: Cross section of the bend.
        width: Width of the core. [um] (legacy; requires ``layer``)
        layer: Main layer of the bend. (legacy)
        enclosure: Slab/exclude definition. (legacy)
    """
    ...

BendSEulerFactory

Bases: Protocol[KC_co]

Source code in kfactory/factories/euler.py
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
class BendSEulerFactory(Protocol[KC_co]):
    def __call__(
        self,
        *,
        offset: um,
        radius: um,
        resolution: float = 150,
        cross_section: str
        | AnyCrossSectionInput
        | CrossSectionSpecDict
        | DCrossSectionSpecDict
        | None = None,
        width: um | None = None,
        layer: kdb.LayerInfo | None = None,
        enclosure: LayerEnclosure | None = None,
    ) -> KC_co:
        """Create a euler s-bend.

        Either pass a ``cross_section`` or the legacy ``width``/``layer``/``enclosure``.

        Args:
            offset: Offset between left/right. [um]
            radius: Radius off the backbone. [um]
            resolution: Angle resolution for the backbone.
            cross_section: Cross section of the bend.
            width: Width of the core. [um] (legacy; requires ``layer``)
            layer: Main layer of the bend. (legacy)
            enclosure: Slab/exclude definition. (legacy)
        """
        ...

__call__

__call__(
    *,
    offset: um,
    radius: um,
    resolution: float = 150,
    cross_section: str
    | AnyCrossSectionInput
    | CrossSectionSpecDict
    | DCrossSectionSpecDict
    | None = None,
    width: um | None = None,
    layer: LayerInfo | None = None,
    enclosure: LayerEnclosure | None = None,
) -> KC_co

Create a euler s-bend.

Either pass a cross_section or the legacy width/layer/enclosure.

Parameters:

Name Type Description Default
offset um

Offset between left/right. [um]

required
radius um

Radius off the backbone. [um]

required
resolution float

Angle resolution for the backbone.

150
cross_section str | AnyCrossSectionInput | CrossSectionSpecDict | DCrossSectionSpecDict | None

Cross section of the bend.

None
width um | None

Width of the core. [um] (legacy; requires layer)

None
layer LayerInfo | None

Main layer of the bend. (legacy)

None
enclosure LayerEnclosure | None

Slab/exclude definition. (legacy)

None
Source code in kfactory/factories/euler.py
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def __call__(
    self,
    *,
    offset: um,
    radius: um,
    resolution: float = 150,
    cross_section: str
    | AnyCrossSectionInput
    | CrossSectionSpecDict
    | DCrossSectionSpecDict
    | None = None,
    width: um | None = None,
    layer: kdb.LayerInfo | None = None,
    enclosure: LayerEnclosure | None = None,
) -> KC_co:
    """Create a euler s-bend.

    Either pass a ``cross_section`` or the legacy ``width``/``layer``/``enclosure``.

    Args:
        offset: Offset between left/right. [um]
        radius: Radius off the backbone. [um]
        resolution: Angle resolution for the backbone.
        cross_section: Cross section of the bend.
        width: Width of the core. [um] (legacy; requires ``layer``)
        layer: Main layer of the bend. (legacy)
        enclosure: Slab/exclude definition. (legacy)
    """
    ...

bend_euler_factory

bend_euler_factory(
    kcl: KCLayout,
    *,
    additional_info: Callable[..., dict[str, MetaData]]
    | dict[str, MetaData]
    | None = None,
    port_type: str = "optical",
    **cell_kwargs: Unpack[CellKWargs],
) -> BendEulerFactory[KCell]
bend_euler_factory(
    kcl: KCLayout,
    *,
    output_type: type[KC],
    additional_info: Callable[..., dict[str, MetaData]]
    | dict[str, MetaData]
    | None = None,
    port_type: str = "optical",
    **cell_kwargs: Unpack[CellKWargs],
) -> BendEulerFactory[KC]
bend_euler_factory(
    kcl: KCLayout,
    *,
    output_type: type[KC] | None = None,
    additional_info: Callable[..., dict[str, MetaData]]
    | dict[str, MetaData]
    | None = None,
    port_type: str = "optical",
    **cell_kwargs: Unpack[CellKWargs],
) -> BendEulerFactory[KC]

Returns a function generating euler bends.

The returned function is the generic interface (cross_section or the legacy width/layer/enclosure). Will snap ports by default.

Parameters:

Name Type Description Default
kcl KCLayout

The KCLayout which will be owned

required
additional_info Callable[..., dict[str, MetaData]] | dict[str, MetaData] | None

Add additional key/values to the KCell.info. Can be a static dict mapping info name to info value. Or can a callable which takes the bend functions' parameters as kwargs and returns a dict with the mapping.

None
cell_kwargs Unpack[CellKWargs]

Additional arguments passed as @kcl.cell(**cell_kwargs).

{}
Source code in kfactory/factories/euler.py
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
def bend_euler_factory(
    kcl: KCLayout,
    *,
    output_type: type[KC] | None = None,
    additional_info: Callable[
        ...,
        dict[str, MetaData],
    ]
    | dict[str, MetaData]
    | None = None,
    port_type: str = "optical",
    **cell_kwargs: Unpack[CellKWargs],
) -> BendEulerFactory[KC]:
    """Returns a function generating euler bends.

    The returned function is the generic interface (``cross_section`` or the legacy
    ``width``/``layer``/``enclosure``). Will snap ports by default.

    Args:
        kcl: The KCLayout which will be owned
        additional_info: Add additional key/values to the
            [`KCell.info`][kfactory.settings.Info]. Can be a static dict
            mapping info name to info value. Or can a callable which takes the bend
            functions' parameters as kwargs and returns a dict with the mapping.
        cell_kwargs: Additional arguments passed as `@kcl.cell(**cell_kwargs)`.
    """
    _additional_info: dict[str, MetaData] = {}
    if _is_additional_info_func(additional_info):
        _additional_info_func: Callable[
            ...,
            dict[str, MetaData],
        ] = additional_info
    else:

        def additional_info_func(
            **kwargs: Any,
        ) -> dict[str, MetaData]:
            return {}

        _additional_info_func = additional_info_func
        _additional_info = additional_info or {}  # ty:ignore[invalid-assignment]
    if cell_kwargs.get("snap_ports") is None:
        cell_kwargs["snap_ports"] = False
    cell_kwargs.setdefault("basename", "bend_euler")
    basename = cell_kwargs["basename"]

    if output_type is not None:
        cell = kcl.cell(output_type=output_type, **cell_kwargs)
    else:
        cell = kcl.cell(output_type=cast("type[KC]", KCell), **cell_kwargs)

    @cell
    def _bend_euler(
        cross_section: str | AnyCrossSectionInput,
        radius: um,
        angle: deg = 90,
        resolution: float = 150,
    ) -> KCell:
        """Euler bend [um] from a cross section."""
        c = kcl.kcell()
        if angle < 0:
            logger.critical(
                f"Negative lengths are not allowed {angle} as ports"
                " will be inverted. Please use a positive number. Forcing positive"
                " lengths."
            )
            angle = -angle

        xs = kcl.get_base_cross_section(cross_section)
        backbone = euler_bend_points(angle, radius=radius, resolution=resolution)

        extrude_path_cross_section(c, backbone, xs, start_angle=0, end_angle=angle)

        c.create_port(
            name="o1",
            cross_section=xs,
            trans=kdb.Trans(2, False, c.kcl.to_dbu(backbone[0]).to_v()),
            port_type=port_type,
        )

        if abs(angle % 90) < 0.001:
            _ang = round(angle)
            c.create_port(
                name="o2",
                trans=kdb.Trans(_ang // 90, False, c.kcl.to_dbu(backbone[-1]).to_v()),
                cross_section=xs,
                port_type=port_type,
            )
        else:
            c.create_port(
                name="o2",
                dcplx_trans=kdb.DCplxTrans(1, angle, False, backbone[-1].to_v()),
                cross_section=xs,
                port_type=port_type,
            )
        _info: dict[str, MetaData] = {}
        _info.update(
            _additional_info_func(
                cross_section=xs,
                radius=radius,
                angle=angle,
                resolution=resolution,
            )
        )
        _info.update(_additional_info)
        c.info = Info(**_info)
        boundary = boundary_from_shapes(c)
        if boundary is not None:
            c.boundary = boundary

        c.auto_rename_ports()
        return c

    @kcl.generic_factory(name=basename)
    def bend_euler(
        *,
        radius: um,
        angle: deg = 90,
        resolution: float = 150,
        cross_section: str
        | AnyCrossSectionInput
        | CrossSectionSpecDict
        | DCrossSectionSpecDict
        | None = None,
        width: um | None = None,
        layer: kdb.LayerInfo | None = None,
        enclosure: LayerEnclosure | None = None,
    ) -> KC:
        if cross_section is None:
            if width is None or layer is None:
                raise ValueError(
                    "Provide a cross_section, or width and layer (legacy call)."
                )
            xs = cross_section_from_width(kcl, kcl.to_dbu(width), layer, enclosure)
        else:
            xs = kcl.get_icross_section(cross_section)
        return _bend_euler(
            cross_section=xs, radius=radius, angle=angle, resolution=resolution
        )

    return bend_euler

bend_s_euler_factory

bend_s_euler_factory(
    kcl: KCLayout,
    *,
    additional_info: Callable[..., dict[str, MetaData]]
    | dict[str, MetaData]
    | None = None,
    port_type: str = "optical",
    **cell_kwargs: Unpack[CellKWargs],
) -> BendSEulerFactory[KCell]
bend_s_euler_factory(
    kcl: KCLayout,
    *,
    output_type: type[KC],
    additional_info: Callable[..., dict[str, MetaData]]
    | dict[str, MetaData]
    | None = None,
    port_type: str = "optical",
    **cell_kwargs: Unpack[CellKWargs],
) -> BendSEulerFactory[KC]
bend_s_euler_factory(
    kcl: KCLayout,
    output_type: type[KC] | None = None,
    additional_info: Callable[..., dict[str, MetaData]]
    | dict[str, MetaData]
    | None = None,
    port_type: str = "optical",
    **cell_kwargs: Unpack[CellKWargs],
) -> BendSEulerFactory[KC]

Returns a function generating euler s-bends (generic interface).

Parameters:

Name Type Description Default
kcl KCLayout

The KCLayout which will be owned

required
additional_info Callable[..., dict[str, MetaData]] | dict[str, MetaData] | None

Add additional key/values to the KCell.info. Can be a static dict mapping info name to info value. Or can a callable which takes the bend functions' parameters as kwargs and returns a dict with the mapping.

None
cell_kwargs Unpack[CellKWargs]

Additional arguments passed as @kcl.cell(**cell_kwargs).

{}
Source code in kfactory/factories/euler.py
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
def bend_s_euler_factory(
    kcl: KCLayout,
    output_type: type[KC] | None = None,
    additional_info: Callable[
        ...,
        dict[str, MetaData],
    ]
    | dict[str, MetaData]
    | None = None,
    port_type: str = "optical",
    **cell_kwargs: Unpack[CellKWargs],
) -> BendSEulerFactory[KC]:
    """Returns a function generating euler s-bends (generic interface).

    Args:
        kcl: The KCLayout which will be owned
        additional_info: Add additional key/values to the
            [`KCell.info`][kfactory.settings.Info]. Can be a static dict
            mapping info name to info value. Or can a callable which takes the bend
            functions' parameters as kwargs and returns a dict with the mapping.
        cell_kwargs: Additional arguments passed as `@kcl.cell(**cell_kwargs)`.
    """
    _additional_info: dict[str, MetaData] = {}
    if _is_additional_info_func(additional_info):
        _additional_info_func: Callable[
            ...,
            dict[str, MetaData],
        ] = additional_info
    else:

        def additional_info_func(
            **kwargs: Any,
        ) -> dict[str, MetaData]:
            return {}

        _additional_info_func = additional_info_func
        _additional_info = additional_info or {}  # ty:ignore[invalid-assignment]
    cell_kwargs.setdefault("basename", "bend_s_euler")
    basename = cell_kwargs["basename"]
    if output_type is not None:
        cell = kcl.cell(output_type=output_type, **cell_kwargs)
    else:
        cell = kcl.cell(output_type=cast("type[KC]", KCell), **cell_kwargs)

    @cell
    def _bend_s_euler(
        cross_section: str | AnyCrossSectionInput,
        offset: um,
        radius: um,
        resolution: float = 150,
    ) -> KCell:
        """Euler s-bend [um] from a cross section."""
        c = kcl.kcell()
        xs = kcl.get_base_cross_section(cross_section)
        backbone = euler_sbend_points(
            offset=offset,
            radius=radius,
            resolution=resolution,
        )
        extrude_path_cross_section(c, backbone, xs, start_angle=0, end_angle=0)

        v = backbone[-1] - backbone[0]
        if v.x < 0:
            p1 = c.kcl.to_dbu(backbone[-1])
            p2 = c.kcl.to_dbu(backbone[0])
        else:
            p1 = c.kcl.to_dbu(backbone[0])
            p2 = c.kcl.to_dbu(backbone[-1])
        c.create_port(
            name="o1",
            trans=kdb.Trans(2, False, p1.to_v()),
            cross_section=xs,
            port_type=port_type,
        )
        c.create_port(
            name="o2",
            trans=kdb.Trans(0, False, p2.to_v()),
            cross_section=xs,
            port_type=port_type,
        )
        boundary = boundary_from_shapes(c)
        if boundary is not None:
            c.boundary = boundary
        _info: dict[str, MetaData] = {}
        _info.update(
            _additional_info_func(
                cross_section=xs,
                offset=offset,
                radius=radius,
                resolution=resolution,
            )
        )
        _info.update(_additional_info)
        c.info = Info(**_info)

        c.auto_rename_ports()
        return c

    @kcl.generic_factory(name=basename)
    def bend_s_euler(
        *,
        offset: um,
        radius: um,
        resolution: float = 150,
        cross_section: str
        | AnyCrossSectionInput
        | CrossSectionSpecDict
        | DCrossSectionSpecDict
        | None = None,
        width: um | None = None,
        layer: kdb.LayerInfo | None = None,
        enclosure: LayerEnclosure | None = None,
    ) -> KC:
        if cross_section is None:
            if width is None or layer is None:
                raise ValueError(
                    "Provide a cross_section, or width and layer (legacy call)."
                )
            xs = cross_section_from_width(kcl, kcl.to_dbu(width), layer, enclosure)
        else:
            xs = kcl.get_icross_section(cross_section)
        return _bend_s_euler(
            cross_section=xs, offset=offset, radius=radius, resolution=resolution
        )

    return bend_s_euler

euler_bend_points

euler_bend_points(
    angle_amount: deg = 90,
    radius: um = 100,
    resolution: float = 150,
) -> list[kdb.DPoint]

Base euler bend, no transformation, emerging from the origin.

Source code in kfactory/factories/euler.py
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
def euler_bend_points(
    angle_amount: deg = 90, radius: um = 100, resolution: float = 150
) -> list[kdb.DPoint]:
    """Base euler bend, no transformation, emerging from the origin."""
    if angle_amount < 0:
        raise ValueError(f"angle_amount should be positive. Got {angle_amount}")
    # End angle
    eth = angle_amount * np.pi / 180

    # If bend is trivial, return a trivial shape
    if eth == 0:
        return [kdb.DPoint(0, 0)]

    # Total displaced angle
    th = eth / 2

    # Total length of curve
    total_length = 4 * radius * th

    # Compute curve ##
    a = np.sqrt(radius**2 * np.abs(th))
    sq2pi = np.sqrt(2 * np.pi)

    # Function for computing curve coords
    (fasin, facos) = fresnel(np.sqrt(2 / np.pi) * radius * th / a)

    def _xy(s: float) -> kdb.DPoint:
        if th == 0:
            return kdb.DPoint(0, 0)
        if s <= total_length / 2:
            (fsin, fcos) = fresnel(s / (sq2pi * a))
            x = sq2pi * a * fcos
            y = sq2pi * a * fsin
        else:
            (fsin, fcos) = fresnel((total_length - s) / (sq2pi * a))
            x = (
                sq2pi
                * a
                * (
                    facos
                    + np.cos(2 * th) * (facos - fcos)
                    + np.sin(2 * th) * (fasin - fsin)
                )
            )
            y = (
                sq2pi
                * a
                * (
                    fasin
                    - np.cos(2 * th) * (fasin - fsin)
                    + np.sin(2 * th) * (facos - fcos)
                )
            )
        return kdb.DPoint(x, y)

    # Parametric step size
    step = total_length / max(int(th * resolution), 1)

    # Generate points
    return [_xy(i * step) for i in range(round(total_length / step) + 1)]

euler_endpoint

euler_endpoint(
    start_point: tuple[float, float] = (0.0, 0.0),
    radius: um = 10.0,
    input_angle: deg = 0.0,
    angle_amount: deg = 90.0,
) -> tuple[float, float]

Gives the end point of a simple Euler bend as a i3.Coord2.

Source code in kfactory/factories/euler.py
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
def euler_endpoint(
    start_point: tuple[float, float] = (0.0, 0.0),
    radius: um = 10.0,
    input_angle: deg = 0.0,
    angle_amount: deg = 90.0,
) -> tuple[float, float]:
    """Gives the end point of a simple Euler bend as a i3.Coord2."""
    th = abs(angle_amount) * np.pi / 180 / 2
    clockwise = angle_amount < 0

    (fsin, fcos) = fresnel(np.sqrt(2 * th / np.pi))

    a = 2 * np.sqrt(2 * np.pi * th) * (np.cos(th) * fcos + np.sin(th) * fsin)
    r = a * radius
    x = r * np.cos(th)
    y = r * np.sin(th)

    if clockwise:
        y *= -1

    return x + start_point[0], y + start_point[1]

euler_sbend_points

euler_sbend_points(
    offset: um = 5.0,
    radius: um = 1e-05,
    resolution: float = 150,
) -> list[kdb.DPoint]

An Euler s-bend with parallel input and output, separated by an offset.

Source code in kfactory/factories/euler.py
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
def euler_sbend_points(
    offset: um = 5.0, radius: um = 10.0e-6, resolution: float = 150
) -> list[kdb.DPoint]:
    """An Euler s-bend with parallel input and output, separated by an offset."""

    # Function to find root of
    def froot(th: float) -> float:
        end_point = euler_endpoint((0.0, 0.0), radius, 0.0, th)
        return 2 * end_point[1] - abs(offset)

    # Get direction
    direction = 1 if offset >= 0 else -1
    # Check whether offset requires straight section
    a = 0.0
    b = 90.0
    fa = froot(a)
    fb = froot(b)

    if fa * fb < 0:
        # Offset can be produced just by bends alone
        angle = direction * brentq(froot, 0.0, 90.0)
        extra_y = 0.0
    else:
        # Offset is greater than max height of bends
        angle = direction * 90.0
        extra_y = -direction * fb

    spoints = []
    right_point = []
    points_left_half = euler_bend_points(abs(angle), radius, resolution)

    # Second bend
    for pts in points_left_half:
        r_pt_x = 2 * points_left_half[-1].x - pts.x
        r_pt_y = 2 * points_left_half[-1].y - pts.y + extra_y * direction
        pts.y = pts.y * direction
        r_pt_y = r_pt_y * direction
        spoints.append(pts)
        right_point.append(kdb.DPoint(r_pt_x, r_pt_y))
    spoints += right_point[::-1]

    return spoints