Skip to content

Straight

straight

Straight virtual straight waveguide cell factories.

StraightVKCell

Bases: Protocol

Source code in kfactory/factories/virtual/straight.py
27
28
29
30
31
32
33
34
35
36
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
class StraightVKCell(Protocol):
    __name__: str

    def __call__(
        self,
        *,
        length: um,
        cross_section: str
        | AnyCrossSectionInput
        | CrossSectionSpecDict
        | DCrossSectionSpecDict
        | None = None,
        width: um | None = None,
        layer: kdb.LayerInfo | None = None,
        enclosure: LayerEnclosure | None = None,
    ) -> VKCell:
        """Virtual straight waveguide defined in um.

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

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

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

__call__

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

Virtual straight waveguide defined in um.

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

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

Parameters:

Name Type Description Default
length um

Waveguide length. [um]

required
cross_section str | AnyCrossSectionInput | CrossSectionSpecDict | DCrossSectionSpecDict | None

Cross section of the waveguide.

None
width um | None

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

None
layer LayerInfo | None

Main layer of the waveguide. (legacy)

None
enclosure LayerEnclosure | None

Definition of slab/excludes. (legacy)

None
Source code in kfactory/factories/virtual/straight.py
30
31
32
33
34
35
36
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
def __call__(
    self,
    *,
    length: um,
    cross_section: str
    | AnyCrossSectionInput
    | CrossSectionSpecDict
    | DCrossSectionSpecDict
    | None = None,
    width: um | None = None,
    layer: kdb.LayerInfo | None = None,
    enclosure: LayerEnclosure | None = None,
) -> VKCell:
    """Virtual straight waveguide defined in um.

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

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

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

virtual_straight_factory

virtual_straight_factory(
    kcl: KCLayout,
    additional_info: Callable[..., dict[str, MetaData]]
    | dict[str, MetaData]
    | None = None,
    basename: str | None = None,
    **cell_kwargs: Any,
) -> StraightVKCell

Returns a function generating virtual straight waveguides.

The returned function is the generic interface: it accepts either a cross_section or the legacy width/layer/enclosure (all um), 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 VKCell.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
basename str | None

Overwrite the prefix of the resulting VKCell's name. By default the VKCell will be named 'virtual_straight[...]'.

None
cell_kwargs Any

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

{}
Source code in kfactory/factories/virtual/straight.py
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 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
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
def virtual_straight_factory(
    kcl: KCLayout,
    additional_info: Callable[
        ...,
        dict[str, MetaData],
    ]
    | dict[str, MetaData]
    | None = None,
    basename: str | None = None,
    **cell_kwargs: Any,
) -> StraightVKCell:
    """Returns a function generating virtual straight waveguides.

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

    Args:
        kcl: The KCLayout which will be owned
        additional_info: Add additional key/values to the
            [`VKCell.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.
        basename: Overwrite the prefix of the resulting VKCell's name. By default
            the VKCell will be named 'virtual_straight[...]'.
        cell_kwargs: Additional arguments passed as `@kcl.vcell(**cell_kwargs)`.
    """
    if _is_additional_info_func(additional_info):
        _additional_info_func: Callable[
            ...,
            dict[str, MetaData],
        ] = additional_info
        _additional_info: dict[str, MetaData] = {}
    else:

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

        _additional_info_func = additional_info_func
        _additional_info = additional_info or {}

    @kcl.vcell(
        basename=basename or "virtual_straight", output_type=VKCell, **cell_kwargs
    )
    def virtual_straight(
        cross_section: str | AnyCrossSectionInput,
        length: um,
    ) -> VKCell:
        """Virtual waveguide defined by a cross section (um)."""
        c = kcl.vkcell()
        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_backbone_cross_section(
            c,
            backbone=[kdb.DPoint(0, 0), kdb.DPoint(length, 0)],
            cross_section=xs,
            start_angle=0,
            end_angle=0,
        )

        _info: dict[str, MetaData] = {}
        _info.update(_additional_info_func(cross_section=xs, length=length))
        _info.update(_additional_info)  # ty:ignore[no-matching-overload]
        c.info = Info(**_info)

        c.create_port(
            name="o1",
            dcplx_trans=kdb.DCplxTrans(1, 180, False, 0, 0),
            cross_section=xs,
        )
        c.create_port(
            name="o2",
            dcplx_trans=kdb.DCplxTrans(1, 0, False, length, 0),
            cross_section=xs,
        )
        return c

    @kcl.generic_factory(name=basename or "virtual_straight")
    def straight(
        *,
        length: um,
        cross_section: str
        | AnyCrossSectionInput
        | CrossSectionSpecDict
        | DCrossSectionSpecDict
        | None = None,
        width: um | None = None,
        layer: kdb.LayerInfo | None = None,
        enclosure: LayerEnclosure | None = None,
    ) -> VKCell:
        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)."
                )
            if width < 0:
                logger.critical(
                    f"Negative widths are not allowed {width}. Forcing positive width."
                )
                width = -width
            xs = cross_section_from_width(kcl, kcl.to_dbu(width), layer, enclosure)
        else:
            xs = kcl.get_icross_section(cross_section)
        return virtual_straight(cross_section=xs, length=length)

    return straight