Added streak finding and white field correction for convergent-beam diffraction experiments;

TODO: cleanup, document streakfinder installation or add to setup

README.md

@@ -105,6 +105,40 @@ options:
        * `'spot_x/spot_y/spot_intensity': 3*list[float]` - Provides coordinates and intensity of the identified peaks within the frame.
        * `'is_hit_frame': True/False` - Marks whether a frame qualifies as a hit based on the number of identified peaks exceeding the defined threshold.
 
+   * **White field correction Algorithm**
+
+     Does the IN PLACE white field correction of the image
+
+     Input parameters:
+       * `'do_whitefield_correction': 1/0` - Specifies whether to do in-place white field correction.
+       * `'wf_data_file': str` - Path to the hdf5 file with corrected white field image.
+       * `'wf_dataset': str` - Name of the dataset containing white field image in the hdf5 file.
+       * `'wf_method': 'div'|'sub'` - Method of white field correction - either division or subtraction is supported.
+
+     Algorithm Output:
+       * `'is_white_field_corrected': bool` - Indicates whether white field correction took place.
+       * Image is changed **in-place**.
+
+   * **streakfinder Algorithm**
+
+     This algorithm is using [streak-finder package](https://github.com/simply-nicky/streak_finder) - a connection-based streak finding algorithm for convergent beam diffraction patterns.
+
+     Input parameters:
+       * `'do_streakfinder_analysis': 1/0` - Specifies whether to execute the streak-finder algorithm.
+       * `'sf_structure_radius': int` - Connectivity structure radius.
+       * `'sf_structure_rank': int` - Connectivity structure rank.
+       * `'sf_min_size': float` - Minimum number of linelets required in a detected streak.
+       * `'sf_vmin': float` - Peak threshold. All peaks with values lower than ``sf_vmin`` are discarded.
+       * `'sf_npts': int` - Support size threshold. The support structure is a connected set of pixels which
+                value is above the threshold ``sf_vmin``. A peak is discarded is the size of support
+                set is lower than ``sf_npts``.
+       * `'sf_xtol': float` - Distance threshold. A new linelet is added to a streak if it's distance to the
+                streak is no more than ``sf_xtol``.
+
+     Algorithm Output:
+       * `'number_of_streaks': int` - Indicates the count of identified peaks.
+       * `'streaks': 4*list[float]` - Provides coordinates of the identified streaks: x0, y0, x1, y1
+
    * **Radial Profile Integration**
 
       This algorithm integrates pixel intensities radially based on defined parameters.
@@ -242,3 +276,4 @@ Algorithms use input parameters specified in a JSON file provided to worker.py (
 
 Special thanks to Valerio Mariani for providing the cython implementation of peakfinder8.
 
+Special thanks to Nikolai Ivanov for providing the cython implementation of streak-finder.