Merge pull request #535 from ANTsX/reg-docs

update reg docs
ANTsX · Feb 16, 2024 · 087d760 · 087d760
2 parents 2ed8e52 + 72566b4
commit 087d760
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/ants/registration/interface.py b/ants/registration/interface.py
@@ -85,6 +85,11 @@ def registration(
 
     flow_sigma : scalar
         smoothing for update field
+        At each iteration, the similarity metric and gradient is calculated. 
+        That gradient field is also called the update field and is smoothed 
+        before composing with the total field (i.e., the estimate of the total 
+        transform at that iteration). This total field can also be smoothed 
+        after each iteration.
 
     total_sigma : scalar
         smoothing for total field