add commit

Analyser/FringeRemoval.py

@@ -21,7 +21,24 @@ class DataSizeException(Exception):
 
 
 class FringeRemoval():
-    """A class for fringes removal
+    """
+    FRINGEREMOVAL - Fringe removal and noise reduction from absorption images.
+    Creates an optimal reference image for each absorption image in a set as 
+    a linear combination of reference images, with coefficients chosen to 
+    minimize the least-squares residuals between each absorption image and 
+    the optimal reference image. The coefficients are obtained by solving a 
+    linear set of equations using matrix inverse by LU decomposition.
+
+    Application of the algorithm is described in C. F. Ockeloen et al, Improved 
+    detection of small atom numbers through image processing, arXiv:1007.2136 (2010).
+
+    Adapted from a MATLAB script copy provided by Guoxian Su.
+    Original Authors: Shannon Whitlock, Caspar Ockeloen
+    Reference: C. F. Ockeloen, A. F. Tauschinsky, R. J. C. Spreeuw, and
+               S. Whitlock, Improved detection of small atom numbers through 
+               image processing, arXiv:1007.2136
+    May 2009;
+    
     """
     
     def __init__(self) -> None: