.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH CROP "1" "February 2024" "GNU Astronomy Utilities 0.22" "User Commands"
.SH NAME
Crop \- crop regions of a dataset
.SH SYNOPSIS
.B astcrop
[\fI\,OPTION\/\fR...] [\fI\,Crop-Identifier\/\fR] \fI\,ASTRdata \/\fR...
.SH DESCRIPTION
Crop is part of GNU Astronomy Utilities 0.22.
Crop will create cutouts, thumbnails, postage stamps or crops of region(s) from
input image(s) using image or celestial coordinates. If muliple crops are
desired, a catalog must be provided. When in WCS mode, if the cut out covers
more than one input image, all overlapping input images will be stitched in the
output.
.PP
For more information, please run any of the following commands. In particular
the second contains a very comprehensive explanation of Crop's invocation:
expected input(s), output(s), and a full description of all the options.
.TP
All options and their values:
$ astcrop \fB\-P\fR
.TP
Inputs/Outputs and options:
$ info astcrop
.TP
Full section in manual/book:
$ info Crop
.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
.PP
Crop options:
.IP
Input:
.TP
\fB\-\-hendwcs\fR=\fI\,INT\/\fR
Header keyword number to stop reading WCS.
.TP
\fB\-\-hstartwcs\fR=\fI\,INT\/\fR
Header keyword number to start reading WCS.
.TP
\fB\-h\fR, \fB\-\-hdu\fR=\fI\,STR\/\fR/INT
Extension name or number of (all) input(s).
.TP
\fB\-O\fR, \fB\-\-mode\fR=\fI\,STR\/\fR
Coordinate mode 'img' or 'wcs'.
.TP
\fB\-z\fR, \fB\-\-zeroisnotblank\fR
0.0 in float or double images are not blank.
.IP
Output:
.TP
\fB\-a\fR, \fB\-\-metaname\fR=\fI\,STR\/\fR
Name of output HDU (EXTNAME keyword in FITS).
.TP
\fB\-A\fR, \fB\-\-append\fR
If output exists, append crop to existing HDUs.
.TP
\fB\-b\fR, \fB\-\-noblank\fR
Remove parts of the crop box out of input image.
.TP
\fB\-D\fR, \fB\-\-dontdelete\fR
Don't delete output if it exists.
.TP
\fB\-K\fR, \fB\-\-keepinputdir\fR
Keep input directory for automatic output.
.TP
\fB\-\-outfitsnocommit\fR
No Git commit in 0\-th HDU of output FITS.
.TP
\fB\-\-outfitsnoconfig\fR
No metadata in 0\-th HDU of output FITS.
.TP
\fB\-\-outfitsnodate\fR
No 'DATE' in 0\-th HDU of output FITS.
.TP
\fB\-\-outfitsnoversions\fR
No versions in 0\-th HDU of output FITS.
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,STR\/\fR
Output file name.
.TP
\fB\-\-primaryimghdu\fR
Write crop in primary/zero\-th HDU of output.
.TP
\fB\-p\fR, \fB\-\-suffix\fR=\fI\,STR\/\fR
Suffix (postfix) of cropped images.
.TP
\fB\-\-tableformat\fR=\fI\,STR\/\fR
Table fmt: 'fits\-ascii', 'fits\-binary', 'txt'.
.TP
\fB\-t\fR, \fB\-\-oneelemstdout\fR
Print one element's value on stdout.
.TP
\fB\-T\fR, \fB\-\-type\fR=\fI\,STR\/\fR
Type of output: e.g., int16, float32, etc...
.TP
\fB\-\-wcslinearmatrix\fR=\fI\,STR\/\fR
WCS linear matrix of output ('pc' or 'cd').
.HP
\fB\-X\fR, \fB\-\-widthinpix\fR           \fB\-\-width\fR is in pixels (even in WCS mode).
.IP
Crop by center
.TP
\fB\-\-checkcenter\fR=\fI\,FLT\/\fR/INT
Width (in pixels) of box at center to check.
.TP
\fB\-c\fR, \fB\-\-center\fR=\fI\,FLT[\/\fR,...]
Central coordinates of a single crop.
.TP
\fB\-w\fR, \fB\-\-width\fR=\fI\,FLT[\/\fR,...]
Width when crop is defined by its center.
.IP
Crop by center (when a catalog is given)
.TP
\fB\-\-cathdu\fR=\fI\,STR\/\fR/INT
HDU of catalog, if it is a FITS table.
.TP
\fB\-C\fR, \fB\-\-catalog\fR=\fI\,FITS\/\fR/TXT
Input catalog filename.
.TP
\fB\-I\fR, \fB\-\-ignorecase\fR
Ignore case in matching/searching columns.
.TP
\fB\-n\fR, \fB\-\-namecol\fR=\fI\,STR\/\fR/INT
Column no./info of crop filename (no suffix).
.TP
\fB\-\-searchin\fR=\fI\,STR\/\fR
Select column(s): 'name', 'unit', 'comment'.
.TP
\fB\-x\fR, \fB\-\-coordcol\fR=\fI\,STR\/\fR/INT
Column no./info containing coordinates.
.IP
Crop by region
.TP
\fB\-l\fR, \fB\-\-polygon\fR=\fI\,FLT\/\fR,FLT[:...]
Polygon vertices, also a DS9 region file.
.TP
\fB\-\-polygonout\fR
Keep the polygon's outside, mask the inside.
.TP
\fB\-\-polygonsort\fR
Sort polygon vertices as counter\-clockwise.
.TP
\fB\-s\fR, \fB\-\-section\fR=\fI\,STR\/\fR
Image section string specifying crop range.
.IP
Operating modes:
.TP
\-?, \fB\-\-help\fR
give this help list
.TP
\fB\-\-checkconfig\fR
List all config files and variables read.
.TP
\fB\-\-cite\fR
BibTeX citation for this program.
.TP
\fB\-\-config\fR=\fI\,STR\/\fR
Read configuration file STR immediately.
.TP
\fB\-\-config\-prefix\fR=\fI\,STR\/\fR
Custom prefix of option names config files.
.TP
\fB\-\-lastconfig\fR
Do not parse any more configuration files.
.TP
\fB\-\-log\fR
Information about output(s) in a log file.
.TP
\fB\-\-minmapsize\fR=\fI\,INT\/\fR
Min. bytes to avoid RAM automatically.
.TP
\fB\-N\fR, \fB\-\-numthreads\fR=\fI\,INT\/\fR
Number of CPU threads to use.
.TP
\fB\-\-onlyversion\fR=\fI\,STR\/\fR
Only run if the program version is STR.
.TP
\fB\-P\fR, \fB\-\-printparams\fR
Print parameter values to be used and abort.
.TP
\fB\-\-quietmmap\fR
Don't print mmap'd file's name and size.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Only report errors, remain quiet about steps.
.TP
\fB\-S\fR, \fB\-\-setdirconf\fR
Set default values for this directory and abort.
.TP
\fB\-\-usage\fR
give a short usage message
.TP
\fB\-U\fR, \fB\-\-setusrconf\fR
Set default values for this user and abort.
.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 Crop
is maintained as a Texinfo manual.  If the
.B info
and
.B Crop
programs are properly installed at your site, the command
.IP
.B info Crop
.PP
should give you access to the complete manual.