gnuastro-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[gnuastro-commits] master 82f8176 08/32: astscript-radial-profile: addin


From: Mohammad Akhlaghi
Subject: [gnuastro-commits] master 82f8176 08/32: astscript-radial-profile: adding usage example to GNUASTRO book
Date: Wed, 24 Feb 2021 22:36:15 -0500 (EST)

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

    astscript-radial-profile: adding usage example to GNUASTRO book
    
    With this commit, a small example to use radial profile astscript has
    been included. Several modifications in the text describing this script
    have also been added.
---
 doc/gnuastro.texi | 26 +++++++++++++++++++-------
 1 file changed, 19 insertions(+), 7 deletions(-)

diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index f1b1919..a8da0c0 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -15423,12 +15423,17 @@ 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.
+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 the 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 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 some 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.
+
+@node Invoking astscript-radial-profile, Radial Profile
+@subsection Invoking astscript-radial-profile
+
 This installed script will read a FITS image and will use it as the basis for 
constructing the radial profile.
+The output radial profile is a FITS table with two columns: radius and 
measured values.
 For more on installed scripts please see (see @ref{Installed scripts}).
 This script can be used with the following general template:
 
@@ -15437,18 +15442,25 @@ $ astscript-radial-profile [OPTION...] FITS-file
 @end example
 
 @noindent
-One line examples:
+Examples:
 
 @example
 ## Generate the radial profile with default options
 $ astscript-radial-profile image.fits
 
+## Generate the radial profile centered at x=44 and y=37 (in pixels), up to
+a radial distance of 19 pixels, use the mean value, and name the output
+columns `RADIUS` and `VALUES`.
+$ astscript-radial-profile image.fits --mode=img --xcenter=44 --ycenter=37 \
+                           --rmax=19 --iname=RADIUS --jname=VALUES
+
 ## 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
+## angle of 148 deg. Name the output table as `radial-profile.fits'
+$ astscript-radial-profile image.fits --mode=wcs --xcenter=20.53751695    \
+                           --ycenter=0.9454292263 --rmax=88 --qratio=0.32 \
+                           --pangle=148 --output=radial-profile.fits
+
 @end example
 
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]