`Fourier2D` Class
===============================================================================

.. currentmodule:: optical.modal

.. autoclass:: optical.modal.Fourier2D

Subclasses
----------

.. autosummary::
   :nosignatures:
   :toctree: Fourier2D
   :template: class.rst

   ~optical.modal.Fourier2D.Eigenmodes
   ~optical.modal.Fourier2D.Mode
   ~optical.modal.Fourier2D.Scattering

Methods
-------

.. autosummary::

   ~optical.modal.Fourier2D.compute_reflectivity
   ~optical.modal.Fourier2D.compute_transmittivity
   ~optical.modal.Fourier2D.find_mode
   ~optical.modal.Fourier2D.gaussian
   ~optical.modal.Fourier2D.get_determinant
   ~optical.modal.Fourier2D.get_raw_E
   ~optical.modal.Fourier2D.get_raw_H
   ~optical.modal.Fourier2D.initialize
   ~optical.modal.Fourier2D.integrateEE
   ~optical.modal.Fourier2D.integrateHH
   ~optical.modal.Fourier2D.invalidate
   ~optical.modal.Fourier2D.layer_eigenmodes
   ~optical.modal.Fourier2D.scattering
   ~optical.modal.Fourier2D.scattering_gaussian
   ~optical.modal.Fourier2D.set_interface
   ~optical.modal.Fourier2D.set_mode

Attributes
----------

Receivers
^^^^^^^^^

.. autosummary::

   ~optical.modal.Fourier2D.inCarriersConcentration
   ~optical.modal.Fourier2D.inEpsilon
   ~optical.modal.Fourier2D.inGain
   ~optical.modal.Fourier2D.inTemperature

Providers
^^^^^^^^^

.. autosummary::

   ~optical.modal.Fourier2D.outDownwardsLightE
   ~optical.modal.Fourier2D.outDownwardsLightH
   ~optical.modal.Fourier2D.outEpsilon
   ~optical.modal.Fourier2D.outLightE
   ~optical.modal.Fourier2D.outLightH
   ~optical.modal.Fourier2D.outLightMagnitude
   ~optical.modal.Fourier2D.outNeff
   ~optical.modal.Fourier2D.outRefractiveIndex
   ~optical.modal.Fourier2D.outUpwardsLightE
   ~optical.modal.Fourier2D.outUpwardsLightH
   ~optical.modal.Fourier2D.outWavelength

Other
^^^^^

.. autosummary::

   ~optical.modal.Fourier2D.beta
   ~optical.modal.Fourier2D.dct
   ~optical.modal.Fourier2D.determinant_type
   ~optical.modal.Fourier2D.emission
   ~optical.modal.Fourier2D.ft
   ~optical.modal.Fourier2D.geometry
   ~optical.modal.Fourier2D.group_layers
   ~optical.modal.Fourier2D.id
   ~optical.modal.Fourier2D.initialized
   ~optical.modal.Fourier2D.interface
   ~optical.modal.Fourier2D.k0
   ~optical.modal.Fourier2D.klong
   ~optical.modal.Fourier2D.ktran
   ~optical.modal.Fourier2D.lam
   ~optical.modal.Fourier2D.lam0
   ~optical.modal.Fourier2D.layer_centers
   ~optical.modal.Fourier2D.layer_edges
   ~optical.modal.Fourier2D.mesh
   ~optical.modal.Fourier2D.mirrors
   ~optical.modal.Fourier2D.modes
   ~optical.modal.Fourier2D.pml
   ~optical.modal.Fourier2D.polarization
   ~optical.modal.Fourier2D.refine
   ~optical.modal.Fourier2D.root
   ~optical.modal.Fourier2D.size
   ~optical.modal.Fourier2D.smooth
   ~optical.modal.Fourier2D.stack
   ~optical.modal.Fourier2D.symmetry
   ~optical.modal.Fourier2D.temp_diff
   ~optical.modal.Fourier2D.temp_dist
   ~optical.modal.Fourier2D.temp_layer
   ~optical.modal.Fourier2D.transfer
   ~optical.modal.Fourier2D.update_gain
   ~optical.modal.Fourier2D.vpml
   ~optical.modal.Fourier2D.wavelength


Descriptions
------------

Method Details
^^^^^^^^^^^^^^

.. automethod:: optical.modal.Fourier2D.compute_reflectivity

.. automethod:: optical.modal.Fourier2D.compute_transmittivity

.. automethod:: optical.modal.Fourier2D.find_mode

.. automethod:: optical.modal.Fourier2D.gaussian

.. automethod:: optical.modal.Fourier2D.get_determinant

.. automethod:: optical.modal.Fourier2D.get_raw_E

.. automethod:: optical.modal.Fourier2D.get_raw_H

.. automethod:: optical.modal.Fourier2D.initialize

.. automethod:: optical.modal.Fourier2D.integrateEE

.. automethod:: optical.modal.Fourier2D.integrateHH

.. automethod:: optical.modal.Fourier2D.invalidate

.. automethod:: optical.modal.Fourier2D.layer_eigenmodes

.. automethod:: optical.modal.Fourier2D.scattering

.. automethod:: optical.modal.Fourier2D.scattering_gaussian

.. automethod:: optical.modal.Fourier2D.set_interface

.. automethod:: optical.modal.Fourier2D.set_mode

Receiver Details
^^^^^^^^^^^^^^^^

.. autoattribute:: optical.modal.Fourier2D.inCarriersConcentration

.. autoattribute:: optical.modal.Fourier2D.inEpsilon

.. autoattribute:: optical.modal.Fourier2D.inGain

.. autoattribute:: optical.modal.Fourier2D.inTemperature

Provider Details
^^^^^^^^^^^^^^^^

.. autoattribute:: optical.modal.Fourier2D.outDownwardsLightE
   :show-signature:

.. autoattribute:: optical.modal.Fourier2D.outDownwardsLightH
   :show-signature:

.. autoattribute:: optical.modal.Fourier2D.outEpsilon
   :show-signature:

.. autoattribute:: optical.modal.Fourier2D.outLightE
   :show-signature:

.. autoattribute:: optical.modal.Fourier2D.outLightH
   :show-signature:

.. autoattribute:: optical.modal.Fourier2D.outLightMagnitude
   :show-signature:

.. autoattribute:: optical.modal.Fourier2D.outNeff
   :show-signature:

.. autoattribute:: optical.modal.Fourier2D.outRefractiveIndex
   :show-signature:

.. autoattribute:: optical.modal.Fourier2D.outUpwardsLightE
   :show-signature:

.. autoattribute:: optical.modal.Fourier2D.outUpwardsLightH
   :show-signature:

.. autoattribute:: optical.modal.Fourier2D.outWavelength
   :show-signature:

Attribute Details
^^^^^^^^^^^^^^^^^

.. autoattribute:: optical.modal.Fourier2D.beta

.. autoattribute:: optical.modal.Fourier2D.dct

.. autoattribute:: optical.modal.Fourier2D.determinant_type

.. autoattribute:: optical.modal.Fourier2D.emission

.. autoattribute:: optical.modal.Fourier2D.ft

.. autoattribute:: optical.modal.Fourier2D.geometry

.. autoattribute:: optical.modal.Fourier2D.group_layers

.. autoattribute:: optical.modal.Fourier2D.id

.. autoattribute:: optical.modal.Fourier2D.initialized

.. autoattribute:: optical.modal.Fourier2D.interface

.. autoattribute:: optical.modal.Fourier2D.k0

.. autoattribute:: optical.modal.Fourier2D.klong

.. autoattribute:: optical.modal.Fourier2D.ktran

.. autoattribute:: optical.modal.Fourier2D.lam

.. autoattribute:: optical.modal.Fourier2D.lam0

.. autoattribute:: optical.modal.Fourier2D.layer_centers

.. autoattribute:: optical.modal.Fourier2D.layer_edges

.. autoattribute:: optical.modal.Fourier2D.mesh

.. autoattribute:: optical.modal.Fourier2D.mirrors

.. autoattribute:: optical.modal.Fourier2D.modes

.. autoattribute:: optical.modal.Fourier2D.pml

.. autoattribute:: optical.modal.Fourier2D.polarization

.. autoattribute:: optical.modal.Fourier2D.refine

.. autoattribute:: optical.modal.Fourier2D.root

.. autoattribute:: optical.modal.Fourier2D.size

.. autoattribute:: optical.modal.Fourier2D.smooth

.. autoattribute:: optical.modal.Fourier2D.stack

.. autoattribute:: optical.modal.Fourier2D.symmetry

.. autoattribute:: optical.modal.Fourier2D.temp_diff

.. autoattribute:: optical.modal.Fourier2D.temp_dist

.. autoattribute:: optical.modal.Fourier2D.temp_layer

.. autoattribute:: optical.modal.Fourier2D.transfer

.. autoattribute:: optical.modal.Fourier2D.update_gain

.. autoattribute:: optical.modal.Fourier2D.vpml

.. autoattribute:: optical.modal.Fourier2D.wavelength

.. template class.rst