[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnuastro-commits] master dd4f925 06/32: astscript-radial-profile: addin
From: |
Mohammad Akhlaghi |
Subject: |
[gnuastro-commits] master dd4f925 06/32: astscript-radial-profile: adding documentation to the GNUASTRO book |
Date: |
Wed, 24 Feb 2021 22:36:15 -0500 (EST) |
branch: master
commit dd4f925d28e014286d741883b20356b90af0e610
Author: Raul Infante-Sainz <infantesainz@gmail.com>
Commit: Raul Infante-Sainz <infantesainz@gmail.com>
astscript-radial-profile: adding documentation to the GNUASTRO book
Until this commit, any information about the `astscript-radial-profile'
script was written into the gnuastro book. This is simply because it was
being developed. Now that I have been testing it with a couple of
examples and it is more o less mature, it is necessary to add the
documentation and information to the book.
With this commit, only the introduction and a couple of examples about
the script have been added to the gnuastro manual book. The description
of all different options is still remaining.
---
doc/gnuastro.texi | 42 ++++++++++++++++++++++++++++++++++++++++++
1 file changed, 42 insertions(+)
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index aecf724..f1b1919 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -15414,6 +15414,48 @@ For random measurements on any area, please use the
upper-limit columns of MakeC
+
+@section Generate radial profile
+
+@cindex Radial, profile
+@cindex Radial profile
+Sometimes it is necessary to compute a radial profile of an astronomical
object.
+For example, imagine you want to study how the light of a galaxy is
distributed as a function of the radial distance from the center.
+This is exactly what a radial profile is.
+Gnuastro's @file{astscript-radial-profile} script is created to obtain such
radial profiles.
+It uses @ref{MakeProfile} to generate elliptical apertures with the values
equal to the distance from the center of the object and @ref{Catalog} for
measuring the values over all the different apertures.
+With the default options, the script will generate a circular radial profile
up to a radial distance of 10 pixels using the median value and centered at the
center of the image.
+In order to have more flexibility, several options are available and the user
can play with them in order to obtain the wanted radial profile.
+In this sense, it can be changed the center position, the maximum radius, the
axis ratio and the position angle (because elliptical apertures are
considered), the operator for obtaining the values, and many other options.
+In addition to this, the user is also able to binning the data and operate
both columns for changing them from the original computed values.
+This installed script will read a FITS image and will use it as the basis for
constructing the radial profile.
+For more on installed scripts please see (see @ref{Installed scripts}).
+This script can be used with the following general template:
+
+@example
+$ astscript-radial-profile [OPTION...] FITS-file
+@end example
+
+@noindent
+One line examples:
+
+@example
+## Generate the radial profile with default options
+$ astscript-radial-profile image.fits
+
+## Generate the radial profile centered at RA=20.53751695, DEC=0.9454292263,
+## up to a radial distance of 88 pixels, axis ratio equal to 0.32 and position
+## angle of 148 deg. Save the ouput as the `radial-profile.fits' table
+$ astscript-radial-profile --xcenter=20.53751695 --ycenter=0.9454292263 \
+ --mode=wcs --rmax=88 --qratio=0.32 --pangle=148 \
+ --output=radial-profile.fits
+@end example
+
+
+
+
+
+
@node Match, , MakeCatalog, Data analysis
@section Match
- [gnuastro-commits] master updated (ea59208 -> 4294506), Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master 863abd7 01/32: astscript-radial-profile: adding script for making radial profiles, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master 7eac053 03/32: astscript-radial-profile: improving comments and information, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master 4e019cb 05/32: astscript-radial-profile: fixing some bugs and modifying metadata, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master dd4f925 06/32: astscript-radial-profile: adding documentation to the GNUASTRO book,
Mohammad Akhlaghi <=
- [gnuastro-commits] master 5e84045 04/32: astscript-radial-profile: allowing to manipulate the final profile, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master 82f8176 08/32: astscript-radial-profile: adding usage example to GNUASTRO book, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master 0634f04 14/32: Book: describing remaining options of radial profile script, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master 2f2970f 09/32: Adding Vim .swp temporal files to .gitignore, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master 3fcd49a 10/32: astscript-radial-profile: setting name and version from the compilation, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master ebab496 15/32: Book: changed the place of radial profile script documentation, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master 6400ca4 16/32: Some minor correction in description, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master 4f3d70d 20/32: Binning data in some case, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master b36c21f 17/32: astscript-radial-profile: modification to use $ instead of c in Table, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master e24caa6 07/32: astscript-radial-profile: user can now specify output column names, Mohammad Akhlaghi, 2021/02/24