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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class BendCircularFactory(Protocol[KC_co]):
    def __call__(
        self,
        *,
        radius: um,
        angle: deg = 90,
        angle_step: deg = 1,
        cross_section: str
        | AnyCrossSectionInput
        | CrossSectionSpecDict
        | DCrossSectionSpecDict
        | None = None,
        width: um | None = None,
        layer: kdb.LayerInfo | None = None,
        enclosure: LayerEnclosure | None = None,
    ) -> KC_co:
        """Circular radius bend [um].

        Either pass a ``cross_section`` (name, spec, or instance) or the legacy
        ``width``/``layer``/``enclosure`` which is normalized into a cross section.

        Args:
            radius: Radius of the backbone. [um]
            angle: Angle amount of the bend.
            angle_step: Angle amount per backbone point of the bend.
            cross_section: Cross section of the bend.
            width: Width of the core. [um] (legacy; requires ``layer``)
            layer: Main layer of the bend. (legacy)
            enclosure: Optional enclosure. (legacy)
        """
        ...

__call__

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

Circular radius bend [um].

Either pass a cross_section (name, spec, or instance) or the legacy width/layer/enclosure which is normalized into a cross section.

Parameters:

Name Type Description Default
radius um

Radius of the backbone. [um]

required
angle deg

Angle amount of the bend.

90
angle_step deg

Angle amount per backbone point of the bend.

1
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

Optional enclosure. (legacy)

None
Source code in kfactory/factories/circular.py
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def __call__(
    self,
    *,
    radius: um,
    angle: deg = 90,
    angle_step: deg = 1,
    cross_section: str
    | AnyCrossSectionInput
    | CrossSectionSpecDict
    | DCrossSectionSpecDict
    | None = None,
    width: um | None = None,
    layer: kdb.LayerInfo | None = None,
    enclosure: LayerEnclosure | None = None,
) -> KC_co:
    """Circular radius bend [um].

    Either pass a ``cross_section`` (name, spec, or instance) or the legacy
    ``width``/``layer``/``enclosure`` which is normalized into a cross section.

    Args:
        radius: Radius of the backbone. [um]
        angle: Angle amount of the bend.
        angle_step: Angle amount per backbone point of the bend.
        cross_section: Cross section of the bend.
        width: Width of the core. [um] (legacy; requires ``layer``)
        layer: Main layer of the bend. (legacy)
        enclosure: Optional enclosure. (legacy)
    """
    ...

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.

The returned function is the generic interface: it accepts either a cross_section or the legacy width/layer/enclosure (normalized into a symmetric cross section). 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/circular.py
 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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
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.

    The returned function is the generic interface: it accepts either a
    ``cross_section`` or the legacy ``width``/``layer``/``enclosure`` (normalized into a
    symmetric cross section). 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_circular")
    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_circular(
        cross_section: str | AnyCrossSectionInput,
        radius: um,
        angle: deg = 90,
        angle_step: deg = 1,
    ) -> KCell:
        """Circular radius bend [um] from a cross section."""
        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

        xs = kcl.get_base_cross_section(cross_section)

        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
                )
            ]
        ]

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

        c.create_port(
            name="o1",
            trans=kdb.Trans(2, False, 0, 0),
            cross_section=xs,
            port_type=port_type,
        )
        c.create_port(
            name="o2",
            dcplx_trans=kdb.DCplxTrans(1, angle, False, backbone[-1].to_v()),
            cross_section=xs,
            port_type=port_type,
        )
        c.auto_rename_ports()
        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,
                radius=radius,
                angle=angle,
                angle_step=angle_step,
            )
        )
        _info.update(_additional_info)
        c.info = Info(**_info)
        return c

    @kcl.generic_factory(name=basename)
    def bend_circular(
        *,
        radius: um,
        angle: deg = 90,
        angle_step: deg = 1,
        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_circular(
            cross_section=xs, radius=radius, angle=angle, angle_step=angle_step
        )

    return bend_circular