Generation of Simulated WaveFront
=================================


* **Running the Test**

  **The Wavefront simulator does not need GPU. you can run it on a normal machine**
  the generation of a simulated wavefront is done with the **wfc** script. You can test it going in the *TEST* directory ::
    
     cd yourdirectoryforwf/TEST
     wfc  input_fzp_small.txt

   Dont forget that if your script is not in the PATH you have to prepend it with its location. If you are on a workstation with a lot of memory
   dont esitate to run the big test. It will be needed in any case as test case for the reconstruction routine ::

    wfc  input_fzp.txt

* **Inspecting the Output**


  The simulation code creates two files ::

    detector_image.h5
    focal_region.h5

  you can easily inspect them with PyMCA_ and check amplitude, squared amplitude, and phase.
  The focal region is a stack of images that you can travel through using the arrow properly
  prompted by PyMca_.




 *the following documentation has been generated automatically from the docstrings found in the source code.*

.. automodule:: wfc
    :noindex:

.. autoclass:: Parameters
    :members: 
    :noindex:


.. _PyMCA: http://pymca.sourceforge.net/