Skip to content

Circular

circular

Circular bends.

A circular bend has a constant radius.

BendCircularFactory

Bases: Protocol[KC_co]

Source code in kfactory/factories/circular.py
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
class BendCircularFactory(Protocol[KC_co]):
    def __call__(
        self,
        width: um,
        radius: um,
        layer: kdb.LayerInfo,
        enclosure: LayerEnclosure | None = None,
        angle: deg = 90,
        angle_step: deg = 1,
    ) -> KC_co:
        """Circular radius bend [um].

        Args:
            width: Width of the core. [um]
            radius: Radius of the backbone. [um]
            layer: Layer index of the target layer.
            enclosure: Optional enclosure.
            angle: Angle amount of the bend.
            angle_step: Angle amount per backbone point of the bend.
        """
        ...

__call__

__call__(
    width: um,
    radius: um,
    layer: LayerInfo,
    enclosure: LayerEnclosure | None = None,
    angle: deg = 90,
    angle_step: deg = 1,
) -> KC_co

Circular radius bend [um].

Parameters:

Name Type Description Default
width um

Width of the core. [um]

required
radius um

Radius of the backbone. [um]

required
layer LayerInfo

Layer index of the target layer.

required
enclosure LayerEnclosure | None

Optional enclosure.

None
angle deg

Angle amount of the bend.

90
angle_step deg

Angle amount per backbone point of the bend.

1
Source code in kfactory/factories/circular.py
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def __call__(
    self,
    width: um,
    radius: um,
    layer: kdb.LayerInfo,
    enclosure: LayerEnclosure | None = None,
    angle: deg = 90,
    angle_step: deg = 1,
) -> KC_co:
    """Circular radius bend [um].

    Args:
        width: Width of the core. [um]
        radius: Radius of the backbone. [um]
        layer: Layer index of the target layer.
        enclosure: Optional enclosure.
        angle: Angle amount of the bend.
        angle_step: Angle amount per backbone point of the bend.
    """
    ...

bend_circular_factory

bend_circular_factory(
    kcl: KCLayout,
    *,
    additional_info: Callable[..., dict[str, MetaData]]
    | dict[str, MetaData]
    | None = None,
    port_type: str = "optical",
    **cell_kwargs: Unpack[CellKWargs],
) -> BendCircularFactory[KCell]
bend_circular_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],
) -> BendCircularFactory[KC]
bend_circular_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],
) -> BendCircularFactory[KC]

Returns a function generating circular bends.

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 straight 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/circular.py
 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
107
108
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
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
def bend_circular_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],
) -> BendCircularFactory[KC]:
    """Returns a function generating circular bends.

    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 straight
            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

    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_circular(
        width: um,
        radius: um,
        layer: kdb.LayerInfo,
        enclosure: LayerEnclosure | None = None,
        angle: deg = 90,
        angle_step: deg = 1,
    ) -> KCell:
        """Circular radius bend [um].

        Args:
            width: Width of the core. [um]
            radius: Radius of the backbone. [um]
            layer: Layer index of the target layer.
            enclosure: Optional enclosure.
            angle: Angle amount of the bend.
            angle_step: Angle amount per backbone point of the bend.
        """
        c = kcl.kcell()
        r = radius

        if angle < 0:
            logger.critical(
                f"Negative angles are not allowed {angle} as ports"
                " will be inverted. Please use a positive number. Forcing positive"
                " lengths."
            )
            angle = -angle
        if width < 0:
            logger.critical(
                f"Negative widths are not allowed {width} as ports"
                " will be inverted. Please use a positive number. Forcing positive"
                " lengths."
            )
            width = -width

        backbone = [
            kdb.DPoint(x, y)
            for x, y in [
                [
                    np.sin(_angle / 180 * np.pi) * r,
                    (-np.cos(_angle / 180 * np.pi) + 1) * r,
                ]
                for _angle in np.linspace(
                    0, angle, int(angle // angle_step + 0.5), endpoint=True
                )
            ]
        ]

        center_path = extrude_path(
            target=c,
            layer=layer,
            path=backbone,
            width=width,
            enclosure=enclosure,
            start_angle=0,
            end_angle=angle,
        )

        c.create_port(
            name="o1",
            trans=kdb.Trans(2, False, 0, 0),
            width=int(width / c.kcl.dbu),
            layer=c.kcl.layer(layer),
            port_type=port_type,
        )
        c.create_port(
            name="o2",
            dcplx_trans=kdb.DCplxTrans(1, angle, False, backbone[-1].to_v()),
            width=c.kcl.to_dbu(width),
            layer=c.kcl.layer(layer),
            port_type=port_type,
        )
        c.auto_rename_ports()
        c.boundary = center_path
        _info: dict[str, MetaData] = {}
        _info.update(
            _additional_info_func(
                width=width,
                radius=radius,
                layer=layer,
                enclosure=enclosure,
                angle=angle,
                angle_step=angle_step,
            )
        )
        _info.update(_additional_info)
        c.info = Info(**_info)
        return c

    return bend_circular