[gnuastro-commits] master a8affac7 2/2: astscript-radial-profile: BibTeX entry from ADS added

[Mohammad Akhlaghi]

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

    astscript-radial-profile: BibTeX entry from ADS added
    
    Until this now, we did not have a formal reference for the paper presenting
    the 'astscript-radial-profile' script.  However, this paper has been
    accepted in the RNAAS, submitted to arXiv and indexed in ADS.
    
    With this commit, I have included this reference into the script (as the
    output of '--cite'), as well as its arXiv URL into the Book. In addition to
    this, I corrected a using example of Warp that was missing one option.
---
 bin/script/color-faint-gray.sh |  1 -
 bin/script/radial-profile.sh   | 71 +++++++++++++++++++++++++++++++++++++++++-
 doc/gnuastro.texi              |  9 +++++-
 3 files changed, 78 insertions(+), 3 deletions(-)

diff --git a/bin/script/color-faint-gray.sh b/bin/script/color-faint-gray.sh
index d80c01d7..41321dfd 100644
--- a/bin/script/color-faint-gray.sh
+++ b/bin/script/color-faint-gray.sh
@@ -258,7 +258,6 @@ EOF
 
 
 
-
 # Functions to check option values and complain if necessary.
 on_off_option_error() {
     if [ "x$2" = x ]; then
diff --git a/bin/script/radial-profile.sh b/bin/script/radial-profile.sh
index 9b01ed0c..d69a351b 100644
--- a/bin/script/radial-profile.sh
+++ b/bin/script/radial-profile.sh
@@ -162,6 +162,75 @@ EOF
 }
 
 
+print_citation() {
+    empty="" # needed for the ascii art!
+    cat <<EOF
+
+Thank you for using $scriptname (GNU Astronomy Utilities) $version
+
+Citations and acknowledgement are vital for the continued work on Gnuastro.
+
+Please cite the following record(s) and add the acknowledgement statement 
below in your work to support us. Please note that different Gnuastro programs 
may have different corresponding papers. Hence, please check all the programs 
you used. Don't forget to also include the version as shown above for 
reproducibility.
+
+Paper introducing this script
+-----------------------------
+  @ARTICLE{astscript-radial-profile,
+         author = {{Infante-Sainz}, Ra{\'u}l and {Akhlaghi}, Mohammad and 
{Eskandarlou}, Sepideh},
+          title = "{Gnuastro: Measuring Radial Profiles from Images}",
+        journal = {Research Notes of the American Astronomical Society},
+       keywords = {Astronomy software, Astronomical techniques, Astronomy data 
visualization, Broad band photometry, Open source software, 1855, 1684, 1968, 
184, 1866},
+           year = 2024,
+          month = jan,
+         volume = {8},
+         number = {1},
+            eid = {22},
+          pages = {22},
+            doi = {10.3847/2515-5172/ad1ee2},
+  archivePrefix = {arXiv},
+         eprint = {2401.05303},
+   primaryClass = {astro-ph.IM},
+         adsurl = {https://ui.adsabs.harvard.edu/abs/2024RNAAS...8...22I},
+        adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+  }
+
+Paper introducing Gnuastro (currently main citation)
+----------------------------------------------------
+  @ARTICLE{gnuastro,
+     author = {{Akhlaghi}, M. and {Ichikawa}, T.},
+      title = "{Noise-based Detection and Segmentation of Nebulous Objects}",
+    journal = {ApJS},
+  archivePrefix = "arXiv",
+     eprint = {1505.01664},
+   primaryClass = "astro-ph.IM",
+       year = 2015,
+      month = sep,
+     volume = 220,
+        eid = {1},
+      pages = {1},
+        doi = {10.1088/0067-0049/220/1/1},
+     adsurl = {https://ui.adsabs.harvard.edu/abs/2015ApJS..220....1A},
+    adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+  }
+
+Acknowledgement
+---------------
+This work was partly done using GNU Astronomy Utilities (Gnuastro, 
ascl.net/1801.009) version $version. Work on Gnuastro has been funded by the 
Japanese Ministry of Education, Culture, Sports, Science, and Technology (MEXT) 
scholarship and its Grant-in-Aid for Scientific Research (21244012, 24253003), 
the European Research Council (ERC) advanced grant 339659-MUSICOS, the Spanish 
Ministry of Economy and Competitiveness (MINECO, grant number AYA2016-76219-P) 
and the NextGenerationEU grant  [...]
+                                               ,
+                                              {|'--.
+                                             {{\    \ $empty
+      Many thanks from all                   |/\`'--./=.
+      Gnuastro developers!                   \`\.---' \`\\
+                                                  |\  ||
+                                                  | |//
+                                                   \//_/|
+                                                   //\__/
+                                                  //
+                   (http://www.chris.com/ascii/) |/
+
+EOF
+}
+
+
 
 
 
@@ -280,7 +349,7 @@ do
         -'?'*|--help=*)         on_off_option_error --help -?;;
         -V|--version)           print_version; exit 0;;
         -V*|--version=*)        on_off_option_error --version -V;;
-        --cite)                 astfits --cite; exit 0;;
+        --cite)                 print_citation; exit 0;;
         --cite=*)               on_off_option_error --cite;;
         -Z|--zeroisnotblank)    zeroisnotblank="--zeroisnotblank"; shift;;
         -Z*|--zeroisnotblank=*) on_off_option_error --zeroisnotblank -Z;;
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 1de64cf4..03fb0dcd 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -1179,10 +1179,12 @@ This is very useful in testing the coverage of dither 
patterns when designing yo
 @item astscript-radial-profile
 (See @ref{Generate radial profile}) Calculate the radial profile of an object 
within an image.
 The object can be at any location in the image, using various measures 
(median, sigma-clipped mean, etc.), and the radial distance can also be 
measured on any general ellipse.
+See Infante-Sainz et al. @url{https://arxiv.org/abs/2401.05303,2024}.
 
 @item astscript-color-faint-gray
 (see @ref{Color images with gray faint regions}) Given three images for the 
Red-Green-Blue (RGB) channels, this script will use the bright pixels for color 
and will show the faint/diffuse regions in grayscale.
 This greatly helps in visualizing the full dynamic range of astronical data.
+See Infante-Sainz et al. @url{https://arxiv.org/abs/2401.03814,2024}.
 
 @item astscript-sort-by-night
 (See @ref{Sort FITS files by night}) Given a list of FITS files, and a HDU and 
keyword name (for a date), this script separates the files in the same night 
(possibly over two calendar days).
@@ -25538,7 +25540,7 @@ $ astwarp image.fits
 ## Align four exposures to same pixel grid and stack them with
 ## Arithmetic program's sigma-clipped mean operator (out of many
 ## stacking operators, see Arithmetic's documentation).
-$ grid="--center=1.234,5.678 --widthinpix=1001,1001 --cdelt=0.2/3600"
+$ grid="--center=1.234,5.678 --width=1001,1001 --widthinpix --cdelt=0.2/3600"
 $ astwarp a.fits $grid --output=A.fits
 $ astwarp b.fits $grid --output=B.fits
 $ astwarp c.fits $grid --output=C.fits
@@ -33436,6 +33438,7 @@ This script uses @ref{MakeProfiles} to generate 
elliptical apertures with the va
 @subsection Invoking astscript-radial-profile
 
 This installed script will measure the radial profile of an object within an 
image.
+A general overview of this script has been published in Infante-Sainz et al. 
@url{https://arxiv.org/abs/2401.05303,2024)}; please cite it if this script 
proves useful in your research.
 For more on installed scripts please see (see @ref{Installed scripts}).
 This script can be used with the following general template:
 
@@ -33748,6 +33751,10 @@ You can disable the deletion of the temporary 
directory with the @option{--keept
 Do Not delete the temporary directory (see description of @option{--tmpdir} 
above).
 This option is useful for debugging.
 For example, to check that the profiles generated for obtaining the radial 
profile have the desired center, shape and orientation.
+
+@item --cite
+Give BibTeX and acknowledgment information for citing this script within your 
paper.
+For more, see @option{Operating mode options}.
 @end table