.. java:import:: ch.epfl.leb.sass.logging Message

.. java:import:: ch.epfl.leb.sass.logging MessageType

.. java:import:: ch.epfl.leb.sass.logging WrongMessageTypeException

.. java:import:: ch.epfl.leb.sass.logging.internal AbstractObservable

.. java:import:: ch.epfl.leb.sass.models.illuminations Illumination

.. java:import:: ch.epfl.leb.sass.models.illuminations IlluminationBuilder

.. java:import:: ch.epfl.leb.sass.models.illuminations ElectricField

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

.. java:import:: java.util.logging Level

.. java:import:: java.util.logging Logger

.. java:import:: org.apache.commons.math3.geometry.euclidean.threed Vector3D

SquareUniformIllumination
=========================

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

.. java:type:: public class SquareUniformIllumination extends AbstractObservable implements Illumination

   Implements a linearly polarized uniform illumination profile of square shape.

   :author: Kyle M. Douglass

Methods
-------
getElectricField
^^^^^^^^^^^^^^^^

.. java:method:: @Override public ElectricField getElectricField()
   :outertype: SquareUniformIllumination

   Retrieves the complex electric field.

   :return: The complex electric field.

getIrradiance
^^^^^^^^^^^^^

.. java:method:: @Override public double getIrradiance(double x, double y, double z)
   :outertype: SquareUniformIllumination

   Returns the irradiance in the sample at the point (x, y, z).

   :param x: The x-position in the sample.
   :param y: The y-position in the sample.
   :param z: The z-position in the sample.

getPower
^^^^^^^^

.. java:method:: @Override public double getPower()
   :outertype: SquareUniformIllumination

   Returns the power carried by the illumination profile. This quantity is the irradiance integrated over the illuminated area and is controlled by the laser power.

   :return: The power carried by the illumination profile.

   **See also:** :java:ref:`.setPower(double)`

setPower
^^^^^^^^

.. java:method:: @Override public void setPower(double power)
   :outertype: SquareUniformIllumination

   Sets the power carried by the illumination.

   :param power: The power carried by the illumination.

update
^^^^^^

.. java:method:: @Override public void update(Object data) throws WrongMessageTypeException
   :outertype: SquareUniformIllumination

   This method is called by an illumination source when its state has changed.

   :param data: The message that is passed from the illumination source.