Scroll to navigation

CONVOLVE(1) User Commands CONVOLVE(1)

NAME

Convolve - convolve an image with a given kernel

SYNOPSIS

astconvolve [OPTION...] InputFile

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.

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.

info astconvolve
info Convolve
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

Convolve options:

Input:
-h, --hdu=STR
Extension name or number of input data.
-H, --mhdu=STR
Mask image header name.
-k, --kernel=STR
Name of kernel for convolution.
-M, --mask=STR
Mask image file name.
--nokernelflip
Do not flip the kernel image.
--nokernelnorm
Do not normalize the kernel image.
-U, --khdu=STR
HDU of kernel file.
Output:
-D, --dontdelete
Don't delete output if it exists.
-K, --keepinputdir
Do not remove input's dir info for output.
-o, --output=STR
Output file or directory name.
-v, --viewfreqsteps
View the steps in the frequency domain.
Mesh grid (only for spatial domain):
-a, --nch1=INT
Number of channels along first FITS axis.
-b, --nch2=INT
Number of channels along second FITS axis.
--checkmesh
Store mesh IDs in `_mesh.fits' file.
--fullconvolution
Ignore channels in imageconvolution.
-L, --lastmeshfrac=INT
Fraction of last mesh area to add new.
-s, --meshsize=INT
Size of each mesh (tile) in the grid.
Operating modes:
-?, --help
give this help list
--cite
BibTeX citation for Convolve.
-f, --frequency
Frequency domain convolution.
-m, --makekernel=INT
Make 2*INT kernel to create input image.
--nolog
No log file for programs which make one.
-N, --numthreads=INT
Number of CPU threads to use.
--onlydirconf
Only read current directory configuration file.
--onlyversion=STR
Only run if the program version is this.
-p, --spatial
Spatial domain convolution.
-P, --printparams
Print parameter values to be used and abort.
-q, --quiet
Only report errors, remain quiet about steps.
--setusrconf
Set default values for this user and abort.
-S, --setdirconf
Set default values for this directory and abort.
--usage
give a short usage message
-V, --version
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/

AUTHOR

Written by Mohammad Akhlaghi

REPORTING BUGS

Report bugs to bug-gnuastro@gnu.org.

COPYRIGHT

Copyright © 2015-2016, 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.

SEE ALSO

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

should give you access to the complete manual.

October 2016 GNU Astronomy Utilities 0.2.33-8a3b