[gnuastro-commits] master c3af771 5/7: Book: signal-to-noise parameters of the radial-profile script are now described.

[Mohammad Akhlaghi]

branch: master
commit c3af771f21b37c699126d763ba074df5f3790039
Author: Carlos Morales Socorro <cmorsoc@gmail.com>
Commit: Mohammad Akhlaghi <mohammad@akhlaghi.org>

    Book: signal-to-noise parameters of the radial-profile script are now 
described.
    
    --sn, --instd and --stdhdu are now described as options of 
astscript-radial-profile.
---
 doc/gnuastro.texi | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index a3d7a30..a8fb258 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -21337,6 +21337,16 @@ Oversample the input dataset to the fraction given to 
this option.
 Therefore if you set @option{--rmax=20} for example and 
@option{--oversample=5}, your output will have 100 rows (without 
@option{--oversample} it will only have 20 rows).
 Unless the object is heavily undersampled (the pixels are larger than the 
actual object), this method provides a much more accurate result and there are 
sufficient number of pixels to get the profile accurately.
 
+@item --instd=FLT/STR
+Sky standard deviation as a single number (FLT) or as the filename (STR) 
containing the image with the std value for each pixel. Only relevant if 
@option{--sn} is requested.
+
+@item --stdhdu=STR
+HDU/extension of the sky standard deviation image specified with 
@option{--instd}. Only relevant if @option{--sn} is requested.
+
+@item  -n
+@item --sn
+Compute the signal to noise ratio for each radius of the profile according to 
@option{--instd} and @option{--stdhdu}. A new column named SN is added to the 
output radial profile.
+
 @item -t STR
 @itemx --tmpdir=STR
 Several intermediate files are necessary to obtain the radial profile.