1. Manuals
  2. Tumbleweed
  3. gnuastro
  4. astcrop(1)

Scroll to navigation

CROP(1) User Commands CROP(1)

NAME

Crop - crop regions of a dataset

SYNOPSIS

astcrop [OPTION...] [Crop-Identifier] ASTRdata ...

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.

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.

$ astcrop -P
$ info astcrop
$ info Crop
$ info gnuastro

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:

$ info help-gnuastro

Crop options:

Input:
Header keyword number to stop reading WCS.
Header keyword number to start reading WCS.
Extension name or number of (all) input(s).
Coordinate mode 'img' or 'wcs'.
0.0 in float or double images are not blank.
Output:
Name of output HDU (EXTNAME keyword in FITS).
If output exists, append crop to existing HDUs.
Remove parts of the crop box out of input image.
Don't delete output if it exists.
Keep input directory for automatic output.
No Git commit in 0-th HDU of output FITS.
No metadata in 0-th HDU of output FITS.
No 'DATE' in 0-th HDU of output FITS.
No versions in 0-th HDU of output FITS.
Output file name.
Write crop in primary/zero-th HDU of output.
Suffix (postfix) of cropped images.
Table fmt: 'fits-ascii', 'fits-binary', 'txt'.
Print one element's value on stdout.
Type of output: e.g., int16, float32, etc...
WCS linear matrix of output ('pc' or 'cd').

-X, --widthinpix --width is in pixels (even in WCS mode).

Crop by center
Width (in pixels) of box at center to check.
Central coordinates of a single crop.
Width when crop is defined by its center.
Crop by center (when a catalog is given)
HDU of catalog, if it is a FITS table.
Input catalog filename.
Ignore case in matching/searching columns.
Column no./info of crop filename (no suffix).
Select column(s): 'name', 'unit', 'comment'.
Column no./info containing coordinates.
Crop by region
Polygon vertices, also a DS9 region file.
Keep the polygon's outside, mask the inside.
Sort polygon vertices as counter-clockwise.
Image section string specifying crop range.
Operating modes:
-?, --help
give this help list
List all config files and variables read.
BibTeX citation for this program.
Read configuration file STR immediately.
Custom prefix of option names config files.
Do not parse any more configuration files.
Information about output(s) in a log file.
Min. bytes to avoid RAM automatically.
Number of CPU threads to use.
Only run if the program version is STR.
Print parameter values to be used and abort.
Don't print mmap'd file's name and size.
Only report errors, remain quiet about steps.
Set default values for this directory and abort.
give a short usage message
Set default values for this user and abort.
print program version

Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.

GNU Astronomy Utilities home page: http://www.gnu.org/software/gnuastro/

REPORTING BUGS

Report bugs to bug-gnuastro@gnu.org.

COPYRIGHT

Copyright © 2015-2024 Free Software Foundation, Inc. License GPLv3+: GNU General public license version 3 or later.
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

Written/developed by Mohammad Akhlaghi

SEE ALSO

The full documentation for Crop is maintained as a Texinfo manual. If the info and Crop programs are properly installed at your site, the command

info Crop

should give you access to the complete manual.

February 2024 GNU Astronomy Utilities 0.22