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 | |
__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 |
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 | |
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
|
None
|
cell_kwargs
|
Unpack[CellKWargs]
|
Additional arguments passed as |
{}
|
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 | |