[gnuastro-commits] master 6d834121 2/2: Book: correcting '--widthinpix' info and values in PSF scripts sections

[Mohammad Akhlaghi]

branch: master
commit 6d8341214f45746fd6b843ade13e8be08cde82de
Author: Raul Infante-Sainz <infantesainz@gmail.com>
Commit: Raul Infante-Sainz <infantesainz@gmail.com>

    Book: correcting '--widthinpix' info and values in PSF scripts sections
    
    Until now, in the Gnuastro book, the description of the option
    '--widthinpix' was not properly updated after it was changed in the PSF
    scripts. The main change was that it now consider two values for accounting
    for different sizes along x and y.
    
    With this commit, the description and values along the documentation book
    has been changed. Now it shows the proper options and values.
    
    Issue reported by Giulia Golini.
---
 doc/gnuastro.texi | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 4e3cc1ab..3a45ce0e 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -6351,9 +6351,9 @@ $ asttable outer/67510-6-10.fits \
                astscript-psf-stamp label/67510-seg.fits \
                     --mode=wcs \
                     --nocentering \
-                    --widthinpix=1000 \
                     --center=$ra,$dec \
                     --normradii=500,510 \
+                    --widthinpix=1000,1000 \
                     --segment=label/67510-seg.fits \
                     --output=finding-normradii/$counter.fits \
                     --tmpdir=finding-normradii --keeptmp; \
@@ -6394,9 +6394,9 @@ $ asttable outer/67510-6-10.fits \
                astscript-psf-stamp label/67510-seg.fits \
                     --mode=wcs \
                     --nocentering \
-                    --widthinpix=1000 \
                     --center=$ra,$dec \
                     --normradii=20,30 \
+                    --widthinpix=1000,1000 \
                     --segment=label/67510-seg.fits \
                     --output=outer/stamps/67510-$counter.fits; \
                counter=$((counter+1)); \
@@ -6467,7 +6467,7 @@ Only the very central core of some of the stars is 
saturated.
 We can therefore use these stars to fill the strong bleeding footprints that 
were present in the outer stack of @file{outer/stack.fits}.
 Similar to before, let's build ready-to-stack crops of these stars.
 To get a better feeling of the normalization radii, follow the same steps of 
@ref{Building outer part of PSF} (setting @option{--tmpdir} and 
@option{--keeptmp}).
-In this case, since the stars are fainter, we can set a smaller size for the 
individual stamps, @option{--widthinpix=500}, to speed up the calculations:
+In this case, since the stars are fainter, we can set a smaller size for the 
individual stamps, @option{--widthinpix=500,500}, to speed up the calculations:
 
 @example
 $ counter=1
@@ -6476,9 +6476,9 @@ $ asttable inner/67510-12-13.fits \
            | while read -r ra dec mag; do
                astscript-psf-stamp label/67510-seg.fits \
                     --mode=wcs \
-                    --widthinpix=500 \
-                    --center=$ra,$dec \
                     --normradii=5,10 \
+                    --center=$ra,$dec \
+                    --widthinpix=500,500 \
                     --segment=label/67510-seg.fits \
                     --output=inner/stamps/67510-$counter.fits; \
                counter=$((counter+1)); \
@@ -27465,7 +27465,7 @@ Examples:
 ## Make a stamp around (x,y)=(53,69) of width=151 pixels.
 ## Normalize the stamp within the radii 20 and 30 pixels.
 $ astscript-psf-stamp image.fits --mode=img \
-      --center=53,69 --widthinpix=151 --normradii=20,30 \
+      --center=53,69 --widthinpix=151,151 --normradii=20,30 \
       --output=stamp.fits
 
 ## Iterate over a catalog with positions of stars that are
@@ -27473,9 +27473,9 @@ $ astscript-psf-stamp image.fits --mode=img \
 $ asttable catalog.fits | while read -r ra dec mag; do \
     astscript-psf-stamp image.fits \
         --mode=wcs \
-        --widthinpix=150 \
         --center=$ra,$dec \
         --normradii=20,30 \
+        --widthinpix=150,150 \
         --output=stamp-"$ra"-"$dec".fits; done
 
 @end example
@@ -27542,8 +27542,8 @@ But for the outer parts it is not too effective, so to 
avoid wasting time for th
 Do Not do the sub-pixel centering to a new pixel grid.
 See the description of the @option{--center} option for more.
 
-@item -W INT
-@itemx --widthinpix=INT
+@item -W INT,INT
+@itemx --widthinpix=INT,INT
 Size (width) of the output image stamp in pixels.
 The size of the output image will be always an odd number of pixels.
 As a consequence, if the user specify an even number, the final size will be 
the specified size plus 1 pixel.
@@ -27828,8 +27828,8 @@ The option takes two values separated by a comma 
(@key{,}).
 The first value is the inner radius, the second is the outer radius.
 These two radii define a ring of pixels around the center that is used for 
obtaining the scale factor value.
 
-@item -W INT
-@itemx --widthinpix=INT
+@item -W INT,INT
+@itemx --widthinpix=INT,INT
 Size (width) of the image stamp in pixels.
 This is an intermediate product computed internally by the script.
 By default, the size of the stamp is automatically set to be as small as 
possible (i.e., two times the external radius of the ring specified by 
@option{--normradii}) to make the computation fast.