:orphan:

.. _single_index:

Single Module
=============

The ``single`` package focuses on scattering from a single particle.  It exposes
simple classes for defining a source, a scatterer and a detector so that the
interaction can be studied in detail.

Key components
--------------
- **Sources** - plane waves and Gaussian beams.
- **Scatterers** - spheres, cylinders and core--shell particles.
- **Detectors** - photodiodes as well as coherent and incoherent detectors.

Example
-------
This example computes the power coupled into a photodiode from a tiny sphere.

.. code-block:: python

   from PyMieSim.single.scatterer import Sphere
   from PyMieSim.single.source import Gaussian
   from PyMieSim.single.detector import Photodiode
   from PyMieSim.units import nanometer, degree, watt, AU, RIU

   source = Gaussian(
       wavelength=450 * nanometer,
       polarization=0 * degree,
       optical_power=1 * watt,
       NA=0.3 * AU,
   )

   scatterer = Sphere(
       diameter=6 * nanometer,
       source=source,
       medium_property=1.0 * RIU,
       property=1.4 * RIU,
   )

   detector = Photodiode(
       NA=0.1 * AU,
       phi_offset=0 * degree,
       gamma_offset=0 * degree,
       sampling=200 * AU,
       polarization_filter=None,
   )

   coupling = detector.coupling(scatterer)
   print(coupling)



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates the process of computing and visualizing the far-fields of a scatterer using PyMieSim.">

.. only:: html

  .. image:: /gallery/single/images/thumb/sphx_glr_farfield_thumb.png
    :alt:

  :ref:`sphx_glr_gallery_single_farfield.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Far-Fields Computation and Visualization</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to compute and visualize the footprint of a scatterer using PyMieSim.">

.. only:: html

  .. image:: /gallery/single/images/thumb/sphx_glr_footprint_thumb.png
    :alt:

  :ref:`sphx_glr_gallery_single_footprint.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Scatterer Footprint Calculation and Visualization</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates the process of computing and visualizing the far-fields of a scatterer using PyMieSim.">

.. only:: html

  .. image:: /gallery/single/images/thumb/sphx_glr_nearfield_thumb.png
    :alt:

  :ref:`sphx_glr_gallery_single_nearfield.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Near-Fields Computation and Visualization</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to compute and visualize the S1 and S2 scattering functions using PyMieSim.">

.. only:: html

  .. image:: /gallery/single/images/thumb/sphx_glr_s1s2_thumb.png
    :alt:

  :ref:`sphx_glr_gallery_single_s1s2.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">S1 S2 Function Computation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to visualize the properties of a light source using PyMieSim.">

.. only:: html

  .. image:: /gallery/single/images/thumb/sphx_glr_source_thumb.png
    :alt:

  :ref:`sphx_glr_gallery_single_source.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Source Plottings</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates the computation and visualization of the Scattering Phase Function (SPF) using PyMieSim.">

.. only:: html

  .. image:: /gallery/single/images/thumb/sphx_glr_spf_thumb.png
    :alt:

  :ref:`sphx_glr_gallery_single_spf.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">SPF Computation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates the computation and visualization of the Stokes parameters using PyMieSim.">

.. only:: html

  .. image:: /gallery/single/images/thumb/sphx_glr_stokes_thumb.png
    :alt:

  :ref:`sphx_glr_gallery_single_stokes.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Stokes Parameters Computation</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /gallery/single/farfield
   /gallery/single/footprint
   /gallery/single/nearfield
   /gallery/single/s1s2
   /gallery/single/source
   /gallery/single/spf
   /gallery/single/stokes



.. only:: html

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

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