Cross section
cross_section
CrossSections for KFactory.
AsymmetricCrossSection
Bases: TAsymmetricCrossSection[int]
dbu-flavored wrapper around an AsymmetricalCrossSection.
Source code in kfactory/cross_section.py
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 | |
AsymmetricalCrossSection
pydantic-model
Bases: BaseModel
Cross section composed of independent layer strips at signed bounds.
The main strip (layer, section_min, section_max) is the port
reference; sections holds any additional strips. All bounds are signed
integer dbu relative to the port centerline (x = 0). Strip edges are
always grid-aligned regardless of width parity.
Fields:
-
layer(LayerInfo) -
section_min(dbu) -
section_max(dbu) -
sections(tuple[CrossSectionLayer, ...]) -
name(str) -
radius(dbu | None) -
radius_min(dbu | None) -
bbox_sections(dict[LayerInfo, dbu])
Validators:
-
_normalize -
_validate
Source code in kfactory/cross_section.py
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 | |
is_named
property
is_named: bool
Whether an explicit name was given (vs. the derived structural name).
main_layer
property
main_layer: LayerInfo
Main layer of the cross section (parity with SymmetricalCrossSection).
width
property
width: int
Main strip width in dbu (section_max - section_min).
auto_name
auto_name() -> str
Deterministic structural name (hash of geometry, excluding radius).
Source code in kfactory/cross_section.py
433 434 435 436 437 438 439 440 441 | |
is_symmetric
is_symmetric() -> bool
Whether this cross section is symmetric.
Source code in kfactory/cross_section.py
489 490 491 | |
CrossSectionLayer
pydantic-model
Bases: BaseModel
Single strip in an asymmetrical cross section.
A strip on layer spanning [section_min, section_max] in dbu relative to
the port centerline (offset=0). Both bounds are signed integer dbu, so
edges are always grid-aligned. The strip's width is the derived
section_max - section_min.
Fields:
Validators:
-
_validate_bounds
Source code in kfactory/cross_section.py
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 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 | |
width
property
width: int
Width of the strip in dbu (section_max - section_min).
CrossSectionModel
pydantic-model
Bases: BaseModel
Fields:
-
cross_sections(dict[str, SymmetricalCrossSection | AsymmetricalCrossSection]) -
kcl(KCLayout)
Source code in kfactory/cross_section.py
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 | |
DAsymmetricCrossSection
Bases: TAsymmetricCrossSection[float]
um-flavored wrapper around an AsymmetricalCrossSection.
Source code in kfactory/cross_section.py
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 | |
DAsymmetricalCrossSection
pydantic-model
Bases: BaseModel
um based AsymmetricalCrossSection.
Fields:
-
layer(LayerInfo) -
section_min(float) -
section_max(float) -
sections(tuple[DCrossSectionLayer, ...]) -
name(str | None) -
radius(float | None) -
radius_min(float | None) -
bbox_sections(dict[LayerInfo, float])
Validators:
-
_validate_bounds
Source code in kfactory/cross_section.py
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 | |
width
property
width: float
Main strip width in um (section_max - section_min).
is_symmetric
is_symmetric() -> bool
Whether this cross section is symmetric.
Source code in kfactory/cross_section.py
603 604 605 | |
DCrossSectionLayer
pydantic-model
Bases: BaseModel
um based CrossSectionLayer.
Fields:
-
layer(LayerInfo) -
section_min(float) -
section_max(float)
Validators:
-
_validate_bounds
Source code in kfactory/cross_section.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 | |
width
property
width: float
Width of the strip in um (section_max - section_min).
DSymmetricalCrossSection
pydantic-model
Bases: BaseModel
um based CrossSection.
Fields:
-
width(float) -
enclosure(DLayerEnclosure) -
name(str | None)
Validators:
-
_validate_width
Source code in kfactory/cross_section.py
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | |
is_symmetric
is_symmetric() -> bool
Whether this cross section is symmetric.
Source code in kfactory/cross_section.py
198 199 200 | |
to_itype
to_itype(kcl: KCLayout) -> SymmetricalCrossSection
Convert to a dbu based CrossSection.
Source code in kfactory/cross_section.py
202 203 204 205 206 207 208 | |
SymmetricalCrossSection
pydantic-model
Bases: BaseModel
CrossSection which is symmetrical to its main_layer/width.
Fields:
-
width(dbu) -
enclosure(LayerEnclosure) -
name(str) -
radius(dbu | None) -
radius_min(dbu | None)
Validators:
-
_set_name -
_validate_enclosure_main_layer -
_validate_width
Source code in kfactory/cross_section.py
59 60 61 62 63 64 65 66 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 | |
bbox_sections
property
bbox_sections: dict[LayerInfo, dbu]
Bounding-box sections (owned by the enclosure).
is_named
property
is_named: bool
Whether an explicit name was given (vs. the enclosure-derived name).
main_layer
property
main_layer: LayerInfo
Main Layer of the enclosure and cross section.
__init__
__init__(
width: dbu,
enclosure: LayerEnclosure,
name: str | None = None,
radius: dbu | None = None,
radius_min: dbu | None = None,
) -> None
Initialized the CrossSection.
bbox_sections live on the enclosure — build the enclosure with them.
Source code in kfactory/cross_section.py
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 | |
is_symmetric
is_symmetric() -> bool
Whether this cross section is symmetric.
Source code in kfactory/cross_section.py
139 140 141 | |
to_dtype
to_dtype(kcl: KCLayout) -> DSymmetricalCrossSection
Convert to a um based CrossSection.
Source code in kfactory/cross_section.py
143 144 145 146 147 148 149 | |
TAsymmetricCrossSection
Bases: ABC
Unit-flavored wrapper around an AsymmetricalCrossSection base.
Mirrors TCrossSection for the symmetric case: both the dbu wrapper
(AsymmetricCrossSection) and the um wrapper (DAsymmetricCrossSection)
hold the same AsymmetricalCrossSection as _base, so they compare equal
across units via .base.
Source code in kfactory/cross_section.py
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 | |
is_symmetric
is_symmetric() -> bool
Whether this cross section is symmetric.
Source code in kfactory/cross_section.py
659 660 661 | |
TCrossSection
Bases: ABC
Source code in kfactory/cross_section.py
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 | |
main_layer
property
main_layer: LayerInfo
Main Layer of the enclosure and cross section.
is_symmetric
is_symmetric() -> bool
Whether this cross section is symmetric.
Source code in kfactory/cross_section.py
997 998 999 | |