.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
.TH CONVOLVE "1" "October 2016" "GNU Astronomy Utilities 0.2.33-8a3b" "User Commands"
.SH NAME
Convolve \- convolve an image with a given kernel
.SH SYNOPSIS
.B astconvolve
[\fI\,OPTION\/\fR...] \fI\,InputFile\/\fR
.SH DESCRIPTION
Convolve is part of GNU Astronomy Utilities 0.2.33\-8a3b.
Convolve will convolve an input image with a given spatial kernel (image) in
the spatial domain (no edge effects) or frequency domain. The latter suffers
from edge effects, but can be much faster.
.PP
For more information, please run any of the following commands. They will
respectively show you the `Invoking Convolve' subsection, the complete
`Convolve' section, or the full GNU Astronomy Utilities manual. In particular
the first contains a very complete explanation of each option.
.IP
info astconvolve
.IP
info Convolve
.IP
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
info help\-gnuastro
.PP
Convolve options:
.IP
Input:
.TP
\fB\-h\fR, \fB\-\-hdu\fR=\fI\,STR\/\fR
Extension name or number of input data.
.TP
\fB\-H\fR, \fB\-\-mhdu\fR=\fI\,STR\/\fR
Mask image header name.
.TP
\fB\-k\fR, \fB\-\-kernel\fR=\fI\,STR\/\fR
Name of kernel for convolution.
.TP
\fB\-M\fR, \fB\-\-mask\fR=\fI\,STR\/\fR
Mask image file name.
.TP
\fB\-\-nokernelflip\fR
Do not flip the kernel image.
.TP
\fB\-\-nokernelnorm\fR
Do not normalize the kernel image.
.TP
\fB\-U\fR, \fB\-\-khdu\fR=\fI\,STR\/\fR
HDU of kernel file.
.IP
Output:
.TP
\fB\-D\fR, \fB\-\-dontdelete\fR
Don't delete output if it exists.
.TP
\fB\-K\fR, \fB\-\-keepinputdir\fR
Do not remove input's dir info for output.
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,STR\/\fR
Output file or directory name.
.TP
\fB\-v\fR, \fB\-\-viewfreqsteps\fR
View the steps in the frequency domain.
.IP
Mesh grid (only for spatial domain):
.TP
\fB\-a\fR, \fB\-\-nch1\fR=\fI\,INT\/\fR
Number of channels along first FITS axis.
.TP
\fB\-b\fR, \fB\-\-nch2\fR=\fI\,INT\/\fR
Number of channels along second FITS axis.
.TP
\fB\-\-checkmesh\fR
Store mesh IDs in `_mesh.fits' file.
.TP
\fB\-\-fullconvolution\fR
Ignore channels in imageconvolution.
.TP
\fB\-L\fR, \fB\-\-lastmeshfrac\fR=\fI\,INT\/\fR
Fraction of last mesh area to add new.
.TP
\fB\-s\fR, \fB\-\-meshsize\fR=\fI\,INT\/\fR
Size of each mesh (tile) in the grid.
.IP
Operating modes:
.TP
\-?, \fB\-\-help\fR
give this help list
.TP
\fB\-\-cite\fR
BibTeX citation for Convolve.
.TP
\fB\-f\fR, \fB\-\-frequency\fR
Frequency domain convolution.
.TP
\fB\-m\fR, \fB\-\-makekernel\fR=\fI\,INT\/\fR
Make 2*INT kernel to create input image.
.TP
\fB\-\-nolog\fR
No log file for programs which make one.
.TP
\fB\-N\fR, \fB\-\-numthreads\fR=\fI\,INT\/\fR
Number of CPU threads to use.
.TP
\fB\-\-onlydirconf\fR
Only read current directory configuration file.
.TP
\fB\-\-onlyversion\fR=\fI\,STR\/\fR
Only run if the program version is this.
.TP
\fB\-p\fR, \fB\-\-spatial\fR
Spatial domain convolution.
.TP
\fB\-P\fR, \fB\-\-printparams\fR
Print parameter values to be used and abort.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Only report errors, remain quiet about steps.
.TP
\fB\-\-setusrconf\fR
Set default values for this user and abort.
.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\-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 AUTHOR
Written by Mohammad Akhlaghi
.SH "REPORTING BUGS"
Report bugs to bug\-gnuastro@gnu.org.
.SH COPYRIGHT
Copyright \(co 2015\-2016, 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.
.SH "SEE ALSO"
The full documentation for
.B Convolve
is maintained as a Texinfo manual.  If the
.B info
and
.B Convolve
programs are properly installed at your site, the command
.IP
.B info Convolve
.PP
should give you access to the complete manual.