[gnuastro-commits] master f393e87: Book: radial profile example using 0.2 as the tolerance for --sigmaclip

[Mohammad Akhlaghi]

branch: master
commit f393e8716be9a8cc6451d23aa1915a3612d6c1e9
Author: Raul Infante-Sainz <infantesainz@gmail.com>
Commit: Mohammad Akhlaghi <mohammad@akhlaghi.org>

    Book: radial profile example using 0.2 as the tolerance for --sigmaclip
    
    Until this commit, in an example describing how to use the radial profile
    script, instead of using a tolerance it was a large number of iterations
    (10).
    
    Since it is better to have a tolerance value, with this commit the
    termination criteria has been changed to 0.1 and the multiple of sigma has
    been increased to 5 (to be sufficiently different from the default values
    of 3,0.2).
---
 doc/gnuastro.texi | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index a2064e2..4313b5e 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -21283,9 +21283,9 @@ $ astscript-radial-profile image.fits --center=44,37 
--rmax=19
 ## Generate the radial profile centered at x=44 and y=37 (in pixels),
 ## up to a radial distance of 100 pixels, compute sigma clipped
 ## mean and standard deviation (sigclip-mean and sigclip-std) using
-## 3 sigma and 10 iterations.
+## 5 sigma and 0.1 tolerance (default is 3 sigma and 0.2 tolerance).
 $ astscript-radial-profile image.fits --center=44,37 --rmax=100 \
-                           --sigmaclip=3,10 \
+                           --sigmaclip=5,0.1 \
                            --measure=sigclip-mean,sigclip-std
 
 ## Generate the radial profile centered at RA=20.53751695,