Skip to content

Straight

straight

Straight waveguide in dbu.

A waveguide is a rectangle of material with excludes and/or slab around it::

┌──────────────────────────────┐
│         Slab/Exclude         │
├──────────────────────────────┤
│                              │
│             Core             │
│                              │
├──────────────────────────────┤
│         Slab/Exclude         │
└──────────────────────────────┘

The slabs and excludes are part of the cross section the waveguide is built from.

StraightFactory

Bases: Protocol[KC_co]

Source code in kfactory/factories/straight.py
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
68
69
70
71
class StraightFactory(Protocol[KC_co]):
    __name__: str

    def __call__(
        self,
        *,
        length: dbu,
        cross_section: str
        | AnyCrossSectionInput
        | CrossSectionSpecDict
        | DCrossSectionSpecDict
        | None = None,
        width: dbu | None = None,
        layer: kdb.LayerInfo | None = None,
        enclosure: LayerEnclosure | None = None,
    ) -> KC_co:
        """Waveguide defined by a cross section, length in dbu.

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

        Args:
            length: Waveguide length. [dbu]
            cross_section: Cross section of the waveguide.
            width: Waveguide width. [dbu] (legacy; requires ``layer``)
            layer: Main layer of the waveguide. (legacy)
            enclosure: Definition of slab/excludes. [dbu] (legacy)
        """
        ...

__call__

__call__(
    *,
    length: dbu,
    cross_section: str
    | AnyCrossSectionInput
    | CrossSectionSpecDict
    | DCrossSectionSpecDict
    | None = None,
    width: dbu | None = None,
    layer: LayerInfo | None = None,
    enclosure: LayerEnclosure | None = None,
) -> KC_co

Waveguide defined by a cross section, length in dbu.

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

Parameters:

Name Type Description Default
length dbu

Waveguide length. [dbu]

required
cross_section str | AnyCrossSectionInput | CrossSectionSpecDict | DCrossSectionSpecDict | None

Cross section of the waveguide.

None
width dbu | None

Waveguide width. [dbu] (legacy; requires layer)

None
layer LayerInfo | None

Main layer of the waveguide. (legacy)

None
enclosure LayerEnclosure | None

Definition of slab/excludes. [dbu] (legacy)

None
Source code in kfactory/factories/straight.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
def __call__(
    self,
    *,
    length: dbu,
    cross_section: str
    | AnyCrossSectionInput
    | CrossSectionSpecDict
    | DCrossSectionSpecDict
    | None = None,
    width: dbu | None = None,
    layer: kdb.LayerInfo | None = None,
    enclosure: LayerEnclosure | None = None,
) -> KC_co:
    """Waveguide defined by a cross section, length in dbu.

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

    Args:
        length: Waveguide length. [dbu]
        cross_section: Cross section of the waveguide.
        width: Waveguide width. [dbu] (legacy; requires ``layer``)
        layer: Main layer of the waveguide. (legacy)
        enclosure: Definition of slab/excludes. [dbu] (legacy)
    """
    ...

straight_dbu_factory

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

Returns a function generating straights [dbu length].

The returned function is the generic interface: it accepts either a cross_section or the legacy width/layer/enclosure (all dbu), normalized into a symmetric cross section.

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/straight.py
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
def straight_dbu_factory(
    kcl: KCLayout,
    additional_info: Callable[
        ...,
        dict[str, MetaData],
    ]
    | dict[str, MetaData]
    | None = None,
    output_type: type[KC] | None = None,
    port_type: str = "optical",
    **cell_kwargs: Unpack[CellKWargs],
) -> StraightFactory[KC]:
    """Returns a function generating straights [dbu length].

    The returned function is the generic interface: it accepts either a
    ``cross_section`` or the legacy ``width``/``layer``/``enclosure`` (all dbu),
    normalized into a symmetric cross section.

    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]

    ports = cell_kwargs.get("ports")
    if ports is None:
        if kcl.rename_function == rename_clockwise:
            cell_kwargs["ports"] = {"left": ["o1"], "right": ["o2"]}
        elif kcl.rename_function == rename_by_direction:
            cell_kwargs["ports"] = {"left": ["W0"], "right": ["E0"]}
    cell_kwargs.setdefault("basename", "straight")
    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 _straight(
        cross_section: str | AnyCrossSectionInput,
        length: dbu,
    ) -> KCell:
        """Waveguide defined by a cross section."""
        c = kcl.kcell()

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

        xs = kcl.get_base_cross_section(cross_section)

        extrude_path_cross_section(
            c, [kdb.DPoint(0.0, 0.0), kdb.DPoint(kcl.to_um(length), 0.0)], xs
        )

        c.create_port(
            name="o1",
            trans=kdb.Trans(2, False, 0, 0),
            cross_section=xs,
            port_type=port_type,
        )
        c.create_port(
            name="o2",
            trans=kdb.Trans(0, False, length, 0),
            cross_section=xs,
            port_type=port_type,
        )

        _info: dict[str, MetaData] = {
            "width_um": kcl.to_um(xs.width),
            "length_um": kcl.to_um(length),
            "width_dbu": xs.width,
            "length_dbu": length,
        }
        _info.update(_additional_info_func(cross_section=xs, length=length))
        _info.update(_additional_info)
        c.info = Info(**_info)

        c.boundary = kdb.DPolygon(c.dbbox())
        c.auto_rename_ports()
        return c

    @kcl.generic_factory(name=basename)
    def straight(
        *,
        length: dbu,
        cross_section: str
        | AnyCrossSectionInput
        | CrossSectionSpecDict
        | DCrossSectionSpecDict
        | None = None,
        width: dbu | 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, width, layer, enclosure)
        else:
            xs = kcl.get_icross_section(cross_section)
        return _straight(cross_section=xs, length=length)

    return straight