[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnuastro-commits] master 0634f04 14/32: Book: describing remaining opti
From: |
Mohammad Akhlaghi |
Subject: |
[gnuastro-commits] master 0634f04 14/32: Book: describing remaining options of radial profile script |
Date: |
Wed, 24 Feb 2021 22:36:17 -0500 (EST) |
branch: master
commit 0634f047d647d5a86814eb0789483ccc39c611b8
Author: Raul Infante-Sainz <infantesainz@gmail.com>
Commit: Raul Infante-Sainz <infantesainz@gmail.com>
Book: describing remaining options of radial profile script
Until this commit, only some options of the radial profile script were
described. But there were several of them still remaining. With this
commit, they have been written into the Book. The options described are:
`--binning', `--cprofiles', `--ccatalog', `--xarith', `--yarith',
`--iname', `--jname' and `--keeptemp'.
---
doc/gnuastro.texi | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 52 insertions(+), 1 deletion(-)
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 8e27cf1..eba41c0 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -15500,7 +15500,7 @@ Same than @option{--xcenter} argument, but for the
second dimension (see above f
@item -R FLT
@itemx --rmax=FLT
Maximum radius for the radial profile (in pixels).
-By default, it is @option{--rmax=10}, which means that the radial profile will
be computed up to a radial distance from the center of 10 pixels.
+By default, it is @option{--rmax=10}, which means that the radial profile will
be computed up to a radial distance of 10 pixels from the centers.
This parameter is used as the options @option{--fcol} and @option{--tcol} in
the generation of the apertures with @command{astmkprof}.
@item -Q FLT
@@ -15522,6 +15522,57 @@ By default, it is @option{--measure=median}, which
means that the median of all
This parameter is used for computing the measured values with
@command{astmkcatalog}.
As a consequence, all operators like median, mean, std, sigclip-mean,
sigclip-number, etc. can be used here.
+@item -b INT
+@itemx --binning=INT
+Binning the radial profile by averaging group of pixels.
+By default, it is @option{--binning=1}, which means that no binning of the
data will be done.
+For example, by setting @option{--rmax=100} and @option{--binning=4}, the
output radial profile will be averaged over group of 4 pixels, so it will have
a total number 25 points.
+This option is useful when it is necessary to increase the signal to noise
ratio of the radial profile.
+
+@item -a STR
+@itemx --cprofiles=STR
+Configuration file for @command{astmkprof}.
+As this script uses @command{astmkprof} internally for generating the
profiles, it may be necessary to use a configuration file for this program.
+
+@item -c STR
+@itemx --ccatalog=STR
+Configuration file for @command{astmkcatalog}.
+As this script uses @command{astmkcatalog} internally for measuring over the
profiles, it may be necessary to use a configuration file for this program.
+
+@item -X STR
+@itemx --xarith=STR
+Operation to be done with the first column of the radial profile (radius).
+By default, the first column of the radial profile is the distance from the
center (in pixels).
+But it is possible to operate this column with the same column arithmetic as
described in @ref{Column arithmetic}.
+For example, if the each pixel is 0.35 arcsec, it is possible to obtain the
first column in units of arcsec with @option{--xarith="0.35 x"}.
+
+@item -Y STR
+@itemx --yarith=STR
+Same option than @option{--xarith} but for the second column of the radial
profile (measured values).
+See above for details.
+For example, if the measured values are in units of mJy (mili-Jansky) but it
is wanted to have it in Jy and then compute the base-10 logarithm, it is
possible to do it with @option{--yarith="1000 / log10"}.
+
+@item -i STR
+@itemx --iname=STR
+Name of the first column of the radial profile.
+By default it is @option{--iname=radius}.
+For example, @option{--iname=DISTANCE} will set the name of the first column
to DISTANCE.
+
+@item -j STR
+@itemx --jname=STR
+Name of the second column of the radial profile.
+By default, the name of the second column will be the operator used for making
the measurement with the leter "v" at the beginning: (@option{--jname=vmedian}).
+For example, measuring the mean values with @option{--measure=mean} will set
the output column name to "vmean" while using if using @option{--measure=std}
will set the output column to "vstd".
+In order to thange the name to any other one, for example FLUX, use
@option{--jname=FLUX}.
+
+@item -k
+@itemx --keeptemp
+Several intermediate files are generated for obtaining the radial profile.
+But, by default they are all removed.
+With the option @option{--keeptemp} (no argument is required) all of these
files will not be removed.
+This option is useful for debugging.
+For example, to check that the profiles generated for obtaining the radial
profile have the same shape and orientation than the source.
+
- [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, 2021/02/24
- [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 <=
- [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
- [gnuastro-commits] master e1ded16 11/32: Book: minor typos and corrections in radial profile script examples, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master 87d68b0 12/32: astscript-radial-profile: removing --rmin option because it is not used, Mohammad Akhlaghi, 2021/02/24
- [gnuastro-commits] master aec3057 13/32: Book: describing most important options of radial profile script, Mohammad Akhlaghi, 2021/02/24