.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH ASTSCRIPT-DS9-REGION "1" "February 2024" "GNU Astronomy Utilities 0.22" "User Commands"
.SH NAME
astscript-ds9-region \- Create an SAO DS9 region file from a table
.SH SYNOPSIS
.B astscript-ds9-region
[\fI\,OPTION\/\fR] \fI\,FITS-files\/\fR
.SH DESCRIPTION
This script is part of GNU Astronomy Utilities 0.22.
.PP
This script will take two column names (or numbers) and return a "region
file" (with one region over each entry) for easy inspection of catalog
entries in this SAO DS9.
.PP
For more information, please run any of the following commands. In
particular the first contains a very comprehensive explanation of this
script's invocation: expected input(s), output(s), and a full description
of all the options.
.TP
Inputs/Outputs and options:
$ info astscript\-ds9\-region
.TP
Full Gnuastro manual/book:
$ info gnuastro
.PP
If you couldn't find your answer in the manual, you can get direct help from
experienced Gnuastro users and developers. For more information, please run:
.IP
\f(CW$ info help-gnuastro\fR
.SS "astscript-ds9-region options:"
.IP
Input:
.TP
\fB\-h\fR, \fB\-\-hdu\fR=\fI\,STR\/\fR
HDU/extension of all input FITS files.
.TP
\fB\-c\fR, \fB\-\-column\fR=\fI\,STR\/\fR,STR
Columns to use as coordinates (name or number).
.TP
\fB\-m\fR, \fB\-\-mode\fR=\fI\,wcs\/\fR|img
Coordinates in WCS or image (default: wcs)
.TP
\fB\-n\fR, \fB\-\-namecol\fR=\fI\,STR\/\fR
ID of each region (name or number of a column)
.IP
Output:
.TP
\fB\-C\fR, \fB\-\-color\fR
Color for the regions (read by DS9).
.TP
\fB\-w\fR, \fB\-\-width\fR
Line thickness of the regions (in DS9).
.TP
\fB\-r\fR, \fB\-\-radius\fR
Radius of each region (arcseconds if in WCS mode).
.TP
\fB\-D\fR, \fB\-\-dontdelete\fR
Don't delete output if it exists.
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,STR\/\fR
Name of output file.
.TP
\fB\-\-command=\fR"STR"
DS9 command to run after making region.
.IP
Operating mode:
.TP
\-?, \fB\-\-help\fR
Print this help list.
.TP
\fB\-\-cite\fR
BibTeX citation for this program.
.TP
\fB\-V\fR, \fB\-\-version\fR
Print program version.
.PP
Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.
.PP
GNU Astronomy Utilities home page: http://www.gnu.org/software/gnuastro/
.SH "REPORTING BUGS"
Report bugs to bug\-gnuastro@gnu.org.
.SH COPYRIGHT
Copyright \(co 2015\-2024 Free Software Foundation, Inc.
License GPLv3+: GNU General public license version 3 or later.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.PP
Written/developed by Mohammad Akhlaghi
.SH "SEE ALSO"
The full documentation for
.B astscript-ds9-region
is maintained as a Texinfo manual.  If the
.B info
and
.B astscript-ds9-region
programs are properly installed at your site, the command
.IP
.B info astscript-ds9-region
.PP
should give you access to the complete manual.