[gnuastro-commits] master d1118894: Book: sigclip-* operators account for the numbers image

[Mohammad Akhlaghi]

branch: master
commit d11188944a756d67d84fc22fe2ddd4ed30a2465a
Author: Mohammad Akhlaghi <mohammad@akhlaghi.org>
Commit: Mohammad Akhlaghi <mohammad@akhlaghi.org>

    Book: sigclip-* operators account for the numbers image
    
    Until now, some instances of the 'sigclip-*' operators of the Arithmetic
    program didn't account for the fact that this operator now returns two
    datasets (the previous output and the numbers image).
    
    With this commit, after a search of this operator such instances were found
    and the commands have been corrected.
    
    This was reported by Hok Kan (Ronald) Tsang.
---
 THANKS                       |  1 +
 doc/announce-acknowledge.txt |  2 ++
 doc/gnuastro.texi            | 18 +++++++++++-------
 3 files changed, 14 insertions(+), 7 deletions(-)

diff --git a/THANKS b/THANKS
index 0759d6b6..ab041d68 100644
--- a/THANKS
+++ b/THANKS
@@ -67,6 +67,7 @@ support in Gnuastro. The list is ordered alphabetically (by 
first name).
     Guillaume Mahler                     guillaume.mahler@univ-lyon1.fr
     Hamed Altafi                         hamed.altafi2@gmail.com
     Helena Domínguez Sánchez             hdominguez@cefca.es
+    Hok Kan (Ronald) Tsang               hkt1992@connect.hku.hk
     Hilderic Browne                      hilderic@storm.ca
     Ignacio Ruiz Cejudo                  igruiz04@ucm.es
     Ignacio Trujillo                     trujillo@iac.es
diff --git a/doc/announce-acknowledge.txt b/doc/announce-acknowledge.txt
index 0e0ae376..537e971d 100644
--- a/doc/announce-acknowledge.txt
+++ b/doc/announce-acknowledge.txt
@@ -1,6 +1,8 @@
 Alphabetically ordered list to acknowledge in the next release.
 
 Antonio Diaz Diaz
+Hok Kan (Ronald) Tsang
+
 
 
 
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 7823fb68..9724464b 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -6771,13 +6771,17 @@ Just recall that we need to specify the number of 
inputs into the stacking opera
 @example
 $ numimgs=$(echo outer/stamps/*.fits | wc -w)
 $ astarithmetic outer/stamps/*.fits $numimgs 3 0.2 sigclip-mean \
-                -g1 --output=outer/stack.fits --wcsfile=none
+                -g1 --output=outer/stack.fits --wcsfile=none \
+                --writeall
 @end example
 
 @noindent
 Did you notice the @option{--wcsfile=none} option above?
 With it, the stacked image no longer has any WCS information.
 This is natural, because the stacked image does not correspond to any specific 
region of the sky any more.
+Also note the @code{--writeall} option: it is necessary because 
@code{sigclip-mean} will return two datasets: the actual stacked image and an 
image showing how many images were ultimately used for each pixel.
+Because of this, the output has two HDUs, containing both these images 
respectiely.
+This is a good check to help improve/debug your results.
 
 Let's compare this stacked PSF with the images of the individual stars that 
were used to create it.
 You can clearly see that the number of masked pixels is significantly 
decreased and the PSF is much more ``cleaner''.
@@ -6848,7 +6852,8 @@ $ asttable inner/67510-12-13.fits \
 
 $ numimgs=$(echo inner/stamps/*.fits | wc -w)
 $ astarithmetic inner/stamps/*.fits $numimgs 3 0.2 sigclip-mean \
-                -g1 --output=inner/stack.fits --wcsfile=none
+                -g1 --output=inner/stack.fits --wcsfile=none \
+                --writeall
 $ astscript-fits-view inner/stack.fits inner/stamps/*.fits
 @end example
 
@@ -10398,7 +10403,7 @@ $ center_ra=192.721250
 $ center_dec=41.120556
 $ astscript-pointing-simulate build/pointing.txt --img=input/ref.fits \
            --center=$center_ra,$center_dec \
-           --width=2 --stack-operator="3 0.2 sigclip-mean" \
+           --width=2 --stack-operator="3 0.2 sigclip-mean swap free" \
            --output=build/stack-noised.fits \
            --hook-warp-after='astarithmetic $WARPED set-i \
                                           i i 0 uint8 eq nan where \
@@ -10843,7 +10848,7 @@ $ for i in $(seq 3); do \
    astnoisechisel jplus-e$i.fits -ojplus-nc$i.fits; \
   done
 
-$ astarithmetic jplus-nc*.fits 3 5 0.2 sigclip-mean \
+$ astarithmetic jplus-nc*.fits 3 5 0.2 sigclip-mean swap free \
                 -gINPUT-NO-SKY -ojplus-stack.fits
 
 $ astscript-fits-view jplus-nc*.fits jplus-stack.fits
@@ -19387,8 +19392,7 @@ This is very useful for selecting the final rows from 
multiple criteria/columns.
 The chosen column does not have to be in the output columns.
 This is good when you just want to select using one column's values, but do 
not need that column anymore afterwards.
 
-For one example of using this option, see the example under
-@option{--sigclip-median} in @ref{Invoking aststatistics}.
+For one example of using this option, see the example under 
@option{--sigclip-median} in @ref{Invoking aststatistics}.
 
 @item --inpolygon=STR1,STR2
 Only return rows where the given coordinates are inside the polygon specified 
by the @option{--polygon} option.
@@ -25748,7 +25752,7 @@ $ astwarp b.fits $grid --output=B.fits
 $ astwarp c.fits $grid --output=C.fits
 $ astwarp d.fits $grid --output=D.fits
 $ astarithmetic A.fits B.fits C.fits D.fits 4 5 0.2 sigclip-mean \
-                -g1 --output=stack.fits
+                -g1 --writeall --output=stack.fits
 
 ## Warp a previously created mock image to the same pixel grid as the
 ## real image (including any distortions).