Updated readme with example photos

README.md

@@ -4,7 +4,9 @@ Multifocal Image Stitching
 |:-----------------:|:----------------:|
 | [![][docs-latest-img]][docs-latest-url] | [![Build Status][build-img]][build-url] |
 
+<img src="assets/image1.png" width="90%"/>
 
+<img src="assets/image2.png" width="90%"/>
 
 ### Installation
 
@@ -19,11 +21,13 @@ Ensure the images to be stitched are sequentially named in `dir`.
 
 ```
 python -m multifocal_stitching -h
-usage: __main__.py [-h] [-v] [-s STITCHING_RESULT] [-d RESULT_DIR] [-r] [--ext EXT] [--no_merge]
-                   [--workers WORKERS] [--min_overlap MIN_OVERLAP]
-                   [--early_term_thresh EARLY_TERM_THRESH] [--use_wins USE_WINS [USE_WINS ...]]
-                   [--peak_cutoff_std PEAK_CUTOFF_STD] [--peaks_dist_threshold PEAKS_DIST_THRESHOLD]
-                   [--filter_radius FILTER_RADIUS [FILTER_RADIUS ...]]
+usage: __main__.py [-h] [-v] [--ext EXT] [--imgs IMGS [IMGS ...]] [--no_merge] [--workers WORKERS]
+                   [--min_overlap MIN_OVERLAP] [--early_term_thresh EARLY_TERM_THRESH]
+                   [--use_wins USE_WINS [USE_WINS ...]] [--peak_cutoff_std PEAK_CUTOFF_STD]
+                   [--peaks_dist_threshold PEAKS_DIST_THRESHOLD]
+                   [--filter_radii FILTER_RADII [FILTER_RADII ...]]
+                   [--stitching_result STITCHING_RESULT] [--result_dir RESULT_DIR]
+                   [--resize_factor RESIZE_FACTOR] [--save_gif]
                    dir
 
 positional arguments:
@@ -32,13 +36,10 @@ positional arguments:
 options:
   -h, --help            show this help message and exit
   -v, --verbose         Increase output verbosity (default: False)
-  -s STITCHING_RESULT, --stitching_result STITCHING_RESULT
-                        Stitching result csv file (default: stitching_result.csv)
-  -d RESULT_DIR, --result_dir RESULT_DIR
-                        Directory to save merged files (default: merged)
-  -r, --exclude_reverse
-                        Whether to additionally include img2 on top of img1 (default: False)
   --ext EXT             Filename extension of images (default: .jpg)
+  --imgs IMGS [IMGS ...]
+                        Stitch only provided images in provided order, otherwise will run in batch
+                        mode over all images in directory (default: None)
   --no_merge            Disable generating merged images (default: False)
   --workers WORKERS     Number of CPU threads to use in FFT (default: 2)
   --min_overlap MIN_OVERLAP
@@ -54,9 +55,16 @@ options:
   --peaks_dist_threshold PEAKS_DIST_THRESHOLD
                         Distance to consider as part of same cluster when finding peak centroid
                         (default: 25)
-  --filter_radius FILTER_RADIUS [FILTER_RADIUS ...]
+  --filter_radii FILTER_RADII [FILTER_RADII ...]
                         Low-pass filter radii to try, smaller matches coarser/out-of-focus features
                         (default: (100, 50, 20))
+  --stitching_result STITCHING_RESULT
+                        Stitching result csv file (default: stitching_result.csv)
+  --result_dir RESULT_DIR
+                        Directory to save merged files (default: merged)
+  --resize_factor RESIZE_FACTOR
+                        Whether to resize the images saved by a factor (default: 1)
+  --save_gif            Whether to save a gif alternating between the merged files (default: False)
 ```
 
 ### Examples