% prSAMP: a phase retrieval algorithm

This software is written by Boshra Rajaei <b.rajaei@sadjad.ac.ir>

This is the version 1.0, released 25/5/2016. 

prSAMP package contains two distinct module: prSAMP for calibration and prSAMP for recovery. 

Calibration module tries to estimate unknown transmission matrix (TM) in a conventional phase retrieval problem y=|Hx| where $y\in R^M$, $H\in C^{MxN}$ and $x \in {0,1}^N$.
TM estimation works using P known input-output samples. Therefore, the actual calibration problem is Y'=|X'H'| where $Y\in R^{PxM}$ and $X\in {0,1}^{PxN}$.
prSAMP in calibration mode uses mpi parallelism to solve the above mentioned problem for each TM column. 

Recovery module calculates y=|Hx| for unknown $x\in C^N$ where measurements $y\in R^M$ and TM $H\in {0,1}^{MxN}$ are asummed to be known. 


# COMPILATION and execution of calibration module:

    make
    mpirun -np  <number_of_processors> ./prSAMP_Calibration <input_file_suffix>

    <input_file_suffix> parameter is the suffix of a text file "input?.txt" in the same path as ./prSAMP_Calib that contains all necessary inputs of prSAMP algorithm.
    For example, if the input file name is "input6140.txt" using 8 processors the execution command should be: 

    mpirun -np  8 ./prSAMP_Calibration 6140

    The output which contains the estimated TM would generate as "output6140.txt" in the same directory. 
    There are two pieces of codes in "useful files" diretory which are appropriate for preparing input file and reading the corresponding output file.
    "save2file_calib" generates input.txt file with necessary prSAMP input parameters and "loadfile_calib" reads the estimated TM from output.txt file. 

    Note: Calibration module requires MPI message interface library.


 
# COMPILATION and execution of recovery module:

    make
    ./prSAMP_Recovery <input_file_suffix>

    <input_file_suffix> parameter is the suffix of a text file "input?.txt" in the same path as ./prSAMP_Recovery that contains all necessary inputs of prSAMP algorithm.
    For example, if the input file name is "input8920.txt" the execution command should be: 

    ./prSAMP_Recovery 8920

    The output which contains the estimated "x" input would generate as "output8920.txt" in the same directory. 
    There are two pieces of codes in "useful files" diretory which are appropriate for preparing input file and reading the corresponding output file.
    "save2file_recovery" generates input.txt file with necessary prSAMP input parameters and "loadfile_recovery" reads the estimated unknown input "x" from output.txt file.