.. java:import:: ch.epfl.leb.sass.models.samples RefractiveIndex

.. java:import:: org.apache.commons.math3.complex Complex

ElectricField
=============

.. java:package:: ch.epfl.leb.sass.models.illuminations
   :noindex:

.. java:type:: public interface ElectricField

   Common methods for ElectricField instances of an illumination profile.

   :author: Kyle M. Douglass

Methods
-------
getEx
^^^^^

.. java:method:: public Complex getEx(double x, double y, double z)
   :outertype: ElectricField

   Returns the x-component of the time-independent electric field at the position (x, y, z).

   :param x: The x-position within the sample.
   :param y: The y-position within the sample.
   :param z: The z-position within the sample.
   :return: The x-component of the electric field at the position (x, y, z).

getEy
^^^^^

.. java:method:: public Complex getEy(double x, double y, double z)
   :outertype: ElectricField

   Returns the y-component of the time-independent electric field at the position (x, y, z).

   :param x: The x-position within the sample.
   :param y: The y-position within the sample.
   :param z: The z-position within the sample.
   :return: The y-component of the electric field at the position (x, y, z).

getEz
^^^^^

.. java:method:: public Complex getEz(double x, double y, double z)
   :outertype: ElectricField

   Returns the z-component of the time-independent electric field at the position (x, y, z).

   :param x: The x-position within the sample.
   :param y: The y-position within the sample.
   :param z: The z-position within the sample.
   :return: The z-component of the electric field at the position (x, y, z).

getRefractiveIndex
^^^^^^^^^^^^^^^^^^

.. java:method:: public RefractiveIndex getRefractiveIndex()
   :outertype: ElectricField

   Returns the sample's refractive index that produced this field.

   :return: The refractive index distribution of the sample.

getWavelength
^^^^^^^^^^^^^

.. java:method:: public double getWavelength()
   :outertype: ElectricField

   Returns the radiation's wavelength.

   :return: The wavelength of the radiation.