PSFBuilder
==========

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

.. java:type:: public interface PSFBuilder

   Defines the Builder interface for constructing PSFs. Passing Builders instances, rather than PSF instances, to the simulation allows the PSF to be constructed at different times during the simulation. For example, one might set basic parameters like the wavelength in the beginning of the simulation and set the emitter's z-position immediately before a frame is computed. This means the simulation can dynamically create new PSF instances in response to changing simulation parameters.

   :author: Kyle M. Douglass

Methods
-------
FWHM
^^^^

.. java:method:: public PSFBuilder FWHM(double FWHM)
   :outertype: PSFBuilder

   The Gaussian approximation's FWHM for this PSF.

NA
^^

.. java:method:: public PSFBuilder NA(double NA)
   :outertype: PSFBuilder

   The numerical aperture of the objective.

build
^^^^^

.. java:method:: public PSF build()
   :outertype: PSFBuilder

   Builds a new instance of the PSF model.

   :return: The PSF model.

eX
^^

.. java:method:: public PSFBuilder eX(double eX)
   :outertype: PSFBuilder

   Sets the emitter's x-position.

   :param eX: The emitter's x-position. [pixels]

eY
^^

.. java:method:: public PSFBuilder eY(double eY)
   :outertype: PSFBuilder

   Sets the emitter's y-position.

   :param eY: The emitter's y-position. [pixels]

eZ
^^

.. java:method:: public PSFBuilder eZ(double eZ)
   :outertype: PSFBuilder

   Sets the emitter's z-position.

   :param eZ: The emitter's z-position. [pixels]

resLateral
^^^^^^^^^^

.. java:method:: public PSFBuilder resLateral(double resLateral)
   :outertype: PSFBuilder

   Object space pixel size

stageDisplacement
^^^^^^^^^^^^^^^^^

.. java:method:: public PSFBuilder stageDisplacement(double stageDisplacement)
   :outertype: PSFBuilder

   Sets the stage displacement for axially-dependent PSFs.

wavelength
^^^^^^^^^^

.. java:method:: public PSFBuilder wavelength(double wavelength)
   :outertype: PSFBuilder

   Wavelength of the light.