.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/devices/example_001_number_state_source.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_devices_example_001_number_state_source.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_devices_example_001_number_state_source.py:


Number State Source Example
===========================

This example demonstrates the use of the
:class:`~symop.devices.models.sources.number_state_source.NumberStateSource`
with the polynomial state.

.. GENERATED FROM PYTHON SOURCE LINES 9-20

.. code-block:: Python


    from __future__ import annotations
    from symop.devices.models.sources import NumberStateSource
    from symop.modes.labels import Path, Polarization
    from symop.modes.envelopes import GaussianEnvelope
    from symop.polynomial.state import KetPolyState

    # Visualization Package
    import symop.viz as VI









.. GENERATED FROM PYTHON SOURCE LINES 21-22

**Setup: set up a mode labels and then the single photon source**

.. GENERATED FROM PYTHON SOURCE LINES 22-29

.. code-block:: Python



    src_env = GaussianEnvelope(omega0=2.0, sigma=1.0, tau=0.0)
    src_pol = Polarization.H()

    src_dev = NumberStateSource(envelope=src_env, polarization=src_pol, n=1)








.. GENERATED FROM PYTHON SOURCE LINES 30-33

**1) Generate the state**
- Generate the vacuum state for the source to populate
- For populating the vacuum ``__call__()`` can be used or ``.apply()``

.. GENERATED FROM PYTHON SOURCE LINES 33-40

.. code-block:: Python


    vac = KetPolyState.vacuum()
    single_photon_state = src_dev(
        vac,
        ports={"out": Path("src_out")},
    )








.. GENERATED FROM PYTHON SOURCE LINES 41-42

**2) Inspect state**

.. GENERATED FROM PYTHON SOURCE LINES 42-44

.. code-block:: Python

    VI.plot(single_photon_state)
    VI.display(single_photon_state)



.. image-sg:: /examples/devices/images/sphx_glr_example_001_number_state_source_001.png
   :alt: $\hat{a}_{1[\mathrm{src\_out}]}^\dagger$, mode 1
   :srcset: /examples/devices/images/sphx_glr_example_001_number_state_source_001.png
   :class: sphx-glr-single-img



.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div class="symop-display">

    <svg class="symop-math-svg" style="color: inherit;" xmlns:xlink="http://www.w3.org/1999/xlink" width="120.64pt" height="28pt" viewBox="0 0 120.64 28" xmlns="http://www.w3.org/2000/svg" version="1.1">
     <metadata>
      <rdf:RDF xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:cc="http://creativecommons.org/ns#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
       <cc:Work>
        <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
        <dc:date>2026-04-24T11:36:44.107077</dc:date>
        <dc:format>image/svg+xml</dc:format>
        <dc:creator>
         <cc:Agent>
          <dc:title>Matplotlib v3.10.9, https://matplotlib.org/</dc:title>
         </cc:Agent>
        </dc:creator>
       </cc:Work>
      </rdf:RDF>
     </metadata>
     <defs>
      <style type="text/css">*{stroke-linejoin: round; stroke-linecap: butt}</style>
     </defs>
     <g id="figure_1">
  
      <g id="text_1">
       <!-- $|\psi_{2}\rangle=\hat{a}_{1[\mathrm{src\_out}]}^\dagger| 0\rangle$ -->
       <g transform="translate(3.6 18.32) scale(0.16 -0.16)">
        <defs>
         <path id="STIXGeneral-Regular-7c" d="M 851 -90 
    L 429 -90 
    L 429 4326 
    L 851 4326 
    L 851 -90 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Italic-3c8" d="M 4275 2822 
    L 4275 2720 
    Q 4096 2688 3955 2579 
    Q 3814 2470 3731 2355 
    Q 3648 2240 3571 2022 
    Q 3494 1805 3465 1689 
    Q 3437 1574 3379 1331 
    Q 3059 -70 1722 -70 
    L 1376 -1312 
    L 890 -1312 
    L 1235 -70 
    L 1178 -70 
    Q 736 -70 550 64 
    Q 211 307 211 864 
    Q 211 1101 332 1517 
    Q 454 1933 454 2144 
    Q 454 2682 96 2720 
    L 102 2822 
    L 442 2822 
    Q 973 2822 973 2170 
    Q 973 1990 861 1472 
    Q 749 954 749 768 
    Q 749 397 880 230 
    Q 1011 64 1274 64 
    L 2010 2739 
    L 2496 2739 
    L 1760 64 
    Q 1997 64 2195 198 
    Q 2675 538 2867 1395 
    Q 2931 1670 2976 1830 
    Q 3021 1990 3120 2204 
    Q 3219 2419 3340 2534 
    Q 3462 2650 3667 2736 
    Q 3872 2822 4134 2822 
    L 4275 2822 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-32" d="M 3034 877 
    L 2688 0 
    L 186 0 
    L 186 77 
    L 1325 1286 
    Q 1773 1754 1965 2144 
    Q 2157 2534 2157 2950 
    Q 2157 3379 1920 3616 
    Q 1683 3853 1267 3853 
    Q 922 3853 720 3673 
    Q 518 3494 326 3021 
    L 192 3053 
    Q 301 3648 630 3987 
    Q 960 4326 1523 4326 
    Q 2054 4326 2380 4006 
    Q 2707 3686 2707 3200 
    Q 2707 2477 1888 1613 
    L 832 486 
    L 2330 486 
    Q 2541 486 2665 569 
    Q 2790 653 2944 915 
    L 3034 877 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-27e9" d="M 2067 1536 
    L 749 -1363 
    L 416 -1363 
    L 1645 1600 
    L 422 4563 
    L 755 4563 
    L 2067 1664 
    L 2067 1536 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-3d" d="M 4077 2048 
    L 307 2048 
    L 307 2470 
    L 4077 2470 
    L 4077 2048 
    z
    M 4077 768 
    L 307 768 
    L 307 1190 
    L 4077 1190 
    L 4077 768 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-302" d="M -480 3245 
    L -698 3245 
    L -1478 3904 
    L -2253 3245 
    L -2470 3245 
    L -1677 4314 
    L -1280 4314 
    L -480 3245 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Italic-61" d="M 2963 710 
    L 3046 640 
    Q 2688 205 2518 70 
    Q 2349 -64 2157 -64 
    Q 1901 -64 1901 198 
    Q 1901 358 2048 934 
    Q 1690 397 1389 163 
    Q 1088 -70 749 -70 
    Q 467 -70 288 125 
    Q 109 320 109 672 
    Q 109 1158 387 1664 
    Q 666 2170 1094 2496 
    Q 1523 2822 1939 2822 
    Q 2368 2822 2451 2451 
    L 2522 2758 
    L 2541 2778 
    L 2931 2822 
    L 2976 2803 
    Q 2970 2778 2938 2669 
    Q 2368 595 2368 346 
    Q 2368 262 2458 262 
    Q 2554 262 2790 525 
    L 2963 710 
    z
    M 2336 2310 
    Q 2336 2477 2240 2579 
    Q 2144 2682 1978 2682 
    Q 1542 2682 1139 2093 
    Q 928 1779 787 1395 
    Q 646 1011 646 717 
    Q 646 243 1030 243 
    Q 1408 243 1843 870 
    Q 2336 1581 2336 2310 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-2020" d="M 1536 -954 
    L 1536 -166 
    Q 1536 282 1459 790 
    Q 1382 1299 1267 1619 
    Q 1536 1894 1536 2803 
    Q 1242 2778 954 2662 
    Q 749 2586 659 2586 
    Q 378 2586 378 2861 
    Q 378 2982 448 3062 
    Q 518 3142 627 3142 
    Q 730 3142 941 3059 
    Q 1280 2925 1536 2918 
    Q 1536 3181 1507 3337 
    Q 1478 3494 1382 3738 
    Q 1306 3930 1306 4038 
    Q 1306 4147 1398 4236 
    Q 1491 4326 1606 4326 
    Q 1722 4326 1814 4236 
    Q 1907 4147 1907 4038 
    Q 1907 3942 1824 3738 
    Q 1728 3501 1702 3344 
    Q 1677 3187 1677 2918 
    Q 1933 2925 2266 3059 
    Q 2470 3142 2586 3142 
    Q 2688 3142 2758 3062 
    Q 2829 2982 2829 2860 
    Q 2829 2739 2761 2662 
    Q 2694 2586 2592 2586 
    Q 2458 2586 2253 2662 
    Q 1952 2778 1677 2803 
    Q 1677 1901 1939 1619 
    Q 1677 941 1677 -166 
    L 1677 -954 
    L 1536 -954 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-31" d="M 2522 0 
    L 755 0 
    L 755 96 
    Q 1107 115 1235 227 
    Q 1363 339 1363 608 
    L 1363 3482 
    Q 1363 3795 1171 3795 
    Q 1082 3795 883 3718 
    L 710 3654 
    L 710 3744 
    L 1856 4326 
    L 1914 4307 
    L 1914 486 
    Q 1914 275 2042 185 
    Q 2170 96 2522 96 
    L 2522 0 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-5b" d="M 1914 -998 
    L 563 -998 
    L 563 4237 
    L 1914 4237 
    L 1914 4077 
    L 1382 4077 
    Q 1216 4077 1133 4006 
    Q 1050 3936 1050 3770 
    L 1050 -493 
    Q 1050 -838 1382 -838 
    L 1914 -838 
    L 1914 -998 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-73" d="M 998 1926 
    L 1664 1523 
    Q 1984 1331 2105 1164 
    Q 2227 998 2227 736 
    Q 2227 416 1961 176 
    Q 1696 -64 1331 -64 
    Q 1030 -64 864 -6 
    Q 691 51 570 51 
    Q 461 51 416 -26 
    L 333 -26 
    L 333 979 
    L 435 979 
    Q 538 512 730 294 
    Q 922 77 1248 77 
    Q 1485 77 1632 211 
    Q 1779 346 1779 550 
    Q 1779 845 1440 1030 
    L 1094 1222 
    Q 326 1651 326 2150 
    Q 326 2522 566 2730 
    Q 806 2938 1210 2938 
    Q 1491 2938 1638 2867 
    Q 1754 2816 1818 2816 
    Q 1862 2816 1920 2880 
    L 1990 2880 
    L 2022 2010 
    L 1926 2010 
    Q 1818 2445 1654 2621 
    Q 1491 2797 1203 2797 
    Q 986 2797 854 2688 
    Q 723 2579 723 2362 
    Q 723 2253 796 2128 
    Q 870 2003 998 1926 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-72" d="M 1024 2931 
    L 1024 2342 
    Q 1267 2688 1430 2816 
    Q 1594 2944 1792 2944 
    Q 1958 2944 2051 2854 
    Q 2144 2765 2144 2605 
    Q 2144 2470 2077 2393 
    Q 2010 2317 1894 2317 
    Q 1773 2317 1638 2445 
    Q 1536 2541 1472 2541 
    Q 1338 2541 1181 2355 
    Q 1024 2170 1024 2016 
    L 1024 576 
    Q 1024 301 1133 205 
    Q 1242 109 1568 96 
    L 1568 0 
    L 32 0 
    L 32 96 
    Q 339 154 412 224 
    Q 486 294 486 538 
    L 486 2138 
    Q 486 2349 438 2435 
    Q 390 2522 269 2522 
    Q 166 2522 45 2496 
    L 45 2598 
    Q 448 2726 992 2944 
    L 1024 2931 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-63" d="M 2547 998 
    L 2637 941 
    Q 2362 403 2112 205 
    Q 1786 -64 1376 -64 
    Q 845 -64 502 336 
    Q 160 736 160 1357 
    Q 160 2170 698 2618 
    Q 1094 2944 1562 2944 
    Q 1965 2944 2256 2749 
    Q 2547 2554 2547 2285 
    Q 2547 2176 2457 2096 
    Q 2368 2016 2246 2016 
    Q 2022 2016 1939 2310 
    L 1901 2451 
    Q 1850 2630 1773 2694 
    Q 1696 2758 1523 2758 
    Q 1133 2758 893 2451 
    Q 653 2144 653 1645 
    Q 653 1094 928 745 
    Q 1203 397 1645 397 
    Q 1920 397 2118 528 
    Q 2317 659 2547 998 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-5f" d="M 3200 -800 
    L 0 -800 
    L 0 -480 
    L 3200 -480 
    L 3200 -800 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-6f" d="M 3008 1478 
    Q 3008 806 2608 371 
    Q 2208 -64 1568 -64 
    Q 979 -64 582 368 
    Q 186 800 186 1459 
    Q 186 2125 582 2534 
    Q 979 2944 1626 2944 
    Q 2221 2944 2614 2537 
    Q 3008 2131 3008 1478 
    z
    M 2432 1306 
    Q 2432 2035 2112 2445 
    Q 1856 2765 1504 2765 
    Q 1171 2765 966 2493 
    Q 762 2221 762 1747 
    Q 762 928 1101 435 
    Q 1318 115 1677 115 
    Q 2029 115 2230 432 
    Q 2432 749 2432 1306 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-75" d="M 3072 320 
    L 3072 230 
    Q 2573 96 2195 -58 
    L 2163 -38 
    L 2163 486 
    L 2150 486 
    Q 1747 -64 1235 -64 
    Q 870 -64 662 160 
    Q 454 384 454 755 
    L 454 2362 
    Q 454 2598 371 2688 
    Q 288 2778 58 2790 
    L 58 2880 
    L 992 2880 
    L 992 813 
    Q 992 595 1123 451 
    Q 1254 307 1446 307 
    Q 1760 307 1984 506 
    Q 2067 582 2099 649 
    Q 2131 717 2131 877 
    L 2131 2355 
    Q 2131 2605 2041 2678 
    Q 1952 2752 1658 2771 
    L 1658 2880 
    L 2669 2880 
    L 2669 685 
    Q 2669 461 2742 390 
    Q 2816 320 3034 320 
    L 3072 320 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-74" d="M 1702 493 
    L 1786 422 
    Q 1478 -64 1011 -64 
    Q 448 -64 448 749 
    L 448 2675 
    L 109 2675 
    Q 83 2694 83 2720 
    Q 83 2771 192 2842 
    Q 435 2982 813 3526 
    Q 826 3546 874 3606 
    Q 922 3667 941 3706 
    Q 986 3706 986 3622 
    L 986 2880 
    L 1632 2880 
    L 1632 2675 
    L 986 2675 
    L 986 845 
    Q 986 538 1062 403 
    Q 1139 269 1318 269 
    Q 1510 269 1702 493 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-5d" d="M 1568 -998 
    L 218 -998 
    L 218 -838 
    L 781 -838 
    Q 947 -838 1014 -768 
    Q 1082 -698 1082 -544 
    L 1082 3731 
    Q 1082 4077 755 4077 
    L 218 4077 
    L 218 4237 
    L 1568 4237 
    L 1568 -998 
    z
    " transform="scale(0.015625)"/>
         <path id="STIXGeneral-Regular-30" d="M 3046 2112 
    Q 3046 1683 2963 1302 
    Q 2880 922 2717 602 
    Q 2554 282 2266 96 
    Q 1978 -90 1600 -90 
    Q 1210 -90 915 108 
    Q 621 307 461 640 
    Q 301 973 227 1350 
    Q 154 1728 154 2150 
    Q 154 2746 301 3222 
    Q 448 3699 790 4012 
    Q 1133 4326 1626 4326 
    Q 2253 4326 2649 3712 
    Q 3046 3098 3046 2112 
    z
    M 2432 2080 
    Q 2432 3091 2217 3625 
    Q 2003 4160 1587 4160 
    Q 1190 4160 979 3622 
    Q 768 3085 768 2106 
    Q 768 1120 979 598 
    Q 1190 77 1600 77 
    Q 2003 77 2217 598 
    Q 2432 1120 2432 2080 
    z
    " transform="scale(0.015625)"/>
        </defs>
        <use xlink:href="#STIXGeneral-Regular-7c" transform="translate(0 0.890625)"/>
        <use xlink:href="#STIXGeneral-Italic-3c8" transform="translate(19.999985 0.890625)"/>
        <use xlink:href="#STIXGeneral-Regular-32" transform="translate(78.399979 -12.3375) scale(0.7)"/>
        <use xlink:href="#STIXGeneral-Regular-27e9" transform="translate(117.809343 0.890625)"/>
        <use xlink:href="#STIXGeneral-Regular-3d" transform="translate(172.249324 0.890625)"/>
        <use xlink:href="#STIXGeneral-Regular-302" transform="translate(309.308053 6.78125)"/>
        <use xlink:href="#STIXGeneral-Italic-61" transform="translate(255.189305 0.890625)"/>
        <use xlink:href="#STIXGeneral-Regular-2020" transform="translate(316.940575 44.684375) scale(0.7)"/>
        <use xlink:href="#STIXGeneral-Regular-31" transform="translate(306.832577 -25.565625) scale(0.7)"/>
        <use xlink:href="#STIXGeneral-Regular-5b" transform="translate(341.832567 -25.565625) scale(0.7)"/>
        <use xlink:href="#STIXGeneral-Regular-73" transform="translate(365.142558 -25.565625) scale(0.7)"/>
        <use xlink:href="#STIXGeneral-Regular-72" transform="translate(392.372554 -25.565625) scale(0.7)"/>
        <use xlink:href="#STIXGeneral-Regular-63" transform="translate(415.682545 -25.565625) scale(0.7)"/>
        <use xlink:href="#STIXGeneral-Regular-5f" transform="translate(446.762541 -25.565625) scale(0.7)"/>
        <use xlink:href="#STIXGeneral-Regular-6f" transform="translate(481.76253 -25.565625) scale(0.7)"/>
        <use xlink:href="#STIXGeneral-Regular-75" transform="translate(516.76252 -25.565625) scale(0.7)"/>
        <use xlink:href="#STIXGeneral-Regular-74" transform="translate(551.762509 -25.565625) scale(0.7)"/>
        <use xlink:href="#STIXGeneral-Regular-5d" transform="translate(571.2225 -25.565625) scale(0.7)"/>
        <use xlink:href="#STIXGeneral-Regular-7c" transform="translate(598.941867 0.890625)"/>
        <use xlink:href="#STIXGeneral-Regular-30" transform="translate(618.941852 0.890625)"/>
        <use xlink:href="#STIXGeneral-Regular-27e9" transform="translate(668.941836 0.890625)"/>
       </g>
      </g>
     </g>
    </svg>
    </div>
    </div>
    <br />
    <br />


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.357 seconds)


.. _sphx_glr_download_examples_devices_example_001_number_state_source.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: example_001_number_state_source.ipynb <example_001_number_state_source.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: example_001_number_state_source.py <example_001_number_state_source.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: example_001_number_state_source.zip <example_001_number_state_source.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_