.. java:import:: java.util ArrayList

.. java:import:: org.apache.commons.math MathException

.. java:import:: ch.epfl.leb.sass.models.emitters.internal Pixel

PSF
===

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

.. java:type:: public interface PSF

   Interface that defines the behavior of a microscope point spread function.

   :author: Kyle M. Douglass

Methods
-------
generatePixelSignature
^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public double generatePixelSignature(int pixelX, int pixelY) throws MathException
   :outertype: PSF

   Computes the expected value for the PSF integrated over a pixel.

   :param pixelX: The pixel's x-position.
   :param pixelY: The pixel's y-position.
   :throws org.apache.commons.math.MathException:
   :return: The relative probability of a photon hitting this pixel.

generateSignature
^^^^^^^^^^^^^^^^^

.. java:method:: public void generateSignature(ArrayList<Pixel> pixels)
   :outertype: PSF

   Computes the digitized PSF across all pixels within the emitter's vicinity.

   :param pixels: The list of pixels spanned by the emitter's image.

getRadius
^^^^^^^^^

.. java:method:: public double getRadius()
   :outertype: PSF

   Returns the radius of the circle that fully encloses the PSF. This value is used to determine how many pixels within the vicinity of the emitter contribute to the PSF. It is necessary because many PSF models extend to infinity in one or more directions.

   :return: The radius of the PSF in pixels.