[gnuastro-commits] master dd7ccfb7: Book: improved description of MakeCatalog's --clumps-sum column

[Mohammad Akhlaghi]

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

    Book: improved description of MakeCatalog's --clumps-sum column
    
    Until now, the description of the '--clumps-sum' column was ambiguous. In
    other words, it did not clarify that if the rivers were subtracted or not
    (in the clumps catalog, did it correspond to the sum of '--sum' or
    '--sum-no-river'?)
    
    With this commit, the description has been edited to be clear about this
    and avoid future confusion.
    
    This issue was raised by Leslie Hunt and Paola Dimauro.
---
 THANKS                       | 1 +
 doc/announce-acknowledge.txt | 2 ++
 doc/gnuastro.texi            | 4 ++--
 3 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/THANKS b/THANKS
index 4a400ff7..01dfdc77 100644
--- a/THANKS
+++ b/THANKS
@@ -42,6 +42,7 @@ support in Gnuastro. The list is ordered alphabetically (by 
family name).
     Nima Dehdilani                       nimadehdilani@gmail.com
     Andrés Del Pino Molina               adelpino@cefca.es
     Antonio Diaz Diaz                    antonio@gnu.org
+    Paola Dimauro                        paola.dimauro@inaf.it
     Alexey Dokuchaev                     danfe@freebsd.org
     Pierre-Alain Duc                     pierre-alain.duc@astro.unistra.fr
     Alessandro Ederoclite                aederocl@gmail.com
diff --git a/doc/announce-acknowledge.txt b/doc/announce-acknowledge.txt
index 5f6b265e..c86ac7c7 100644
--- a/doc/announce-acknowledge.txt
+++ b/doc/announce-acknowledge.txt
@@ -4,10 +4,12 @@ Bharat Bhandari
 Faezeh Bidjarchian
 Alejandro Serrano Borlaff
 Fernando Buitrago
+Paola Dimauro
 Sepideh Eskandarlou
 Zohreh Ghaffari
 Giulia Golini
 Siyang He
+Leslie Hunt
 Martin Kuemmel
 Teet Kuutma
 Samane Raji
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index d920104b..a137619d 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -25290,8 +25290,8 @@ The latter situation usually happens when there is a 
bug in the previous steps o
 If you want to ignore those pixels in the error measurement, set them to zero 
(which is a meaningful number in such scenarios).
 
 @item --clumps-sum
-[Objects] The total sum of the clumps within an object.
-This is simply the sum of the pixels associated with clumps in the object.
+[Objects] The total sum of the pixels covered by clumps (before subtracting 
the river) within each object.
+This is simply the sum of @option{--sum-no-river} in the clumps catalog (see 
below).
 If no usable pixels are present over the clump or object (for example, they 
are all blank), the stored value will be NaN (note that zero is meaningful).
 
 @item --sum-no-river