imsmooth – Smooth an image or portion of an image – analysis task

Description

Parameters

Title

Parameter	Default	Description
imagename	''	Name of the input image. Must be specified.
kernel	'gauss'	Type of kernel to use. Acceptable values are “b”, “box”, or “boxcar” for a boxcar kernel, “g”, “gauss”, or “gaussian” for a gaussian kernel, “c”, “common”, or “commonbeam” to use the common beam of an image with multiple beams as the gaussian to which to convolve all the planes, “i” or “image” to use an image as the kernel.
major	''	Major axis for the kernels. Standard quantity representation. Must be specified for kernel=”boxcar”.
minor	''	Minor axis. Standard quantity representation. Must be specified for kernel=”boxcar”.
pa	''	Position angle used only for gaussian kernel. Standard quantity representation.
targetres	False	If gaussian kernel, specified parameters are to be resolution of output image (True) or parameters of gaussian to convolve with input image (False).
kimage	''	Kernel image name. Only used if kernel=”i” or “image”.
scale	float(-1.0)	Scale factor. -1.0 means auto-scale. Only used if kernel=”i” or “image”.
region	''	Region selection. Default is to use the full image.
box	''	Rectangular region to select in direction plane. Default is to use the entire direction plane.
chans	''	Channels to use. Default is to use all channels.
stokes	''	Stokes planes to use. Default is to use all Stokes planes.
mask	''	Mask to use. Default is none.
outfile	''	Output image name. Must be specified.
stretch	False	If true, stretch the mask if necessary and possible.
overwrite	False	If true, overwrite (unprompted) pre-existing output file.
beam	''	Alternate way of describing a Gaussian. If specified, must be a dictionary with keys “major”, “minor”, and “pa” (or “positionangle”). Do not specify beam if specifying major, minor, and pa.

Parameter Explanations

imagename

''

Name of the input image. Must be specified.

kernel

'gauss'

Type of kernel to use. Acceptable values are “b”, “box”, or “boxcar” for a boxcar kernel, “g”, “gauss”, or “gaussian” for a gaussian kernel, “c”, “common”, or “commonbeam” to use the common beam of an image with multiple beams as the gaussian to which to convolve all the planes, “i” or “image” to use an image as the kernel.

major

''

Major axis for the kernels. Standard quantity representation. Must be specified for kernel=”boxcar”.

minor

''

Minor axis. Standard quantity representation. Must be specified for kernel=”boxcar”.

pa

''

Position angle used only for gaussian kernel. Standard quantity representation.

targetres

False

If gaussian kernel, specified parameters are to be resolution of output image (True) or parameters of gaussian to convolve with input image (False).

kimage

''

Kernel image name. Only used if kernel=”i” or “image”.

scale

float(-1.0)

Scale factor. -1.0 means auto-scale. Only used if kernel=”i” or “image”.

region

''

Region selection. Default is to use the full image.

box

''

Rectangular region to select in direction plane. Default is to use the entire direction plane.

chans

''

Channels to use. Default is to use all channels.

stokes

''

Stokes planes to use. Default is to use all Stokes planes.

mask

''

Mask to use. Default is none.

outfile

''

Output image name. Must be specified.

stretch

False

If true, stretch the mask if necessary and possible.

overwrite

False

If true, overwrite (unprompted) pre-existing output file.

beam

''

Alternate way of describing a Gaussian. If specified, must be a dictionary with keys “major”, “minor”, and “pa” (or “positionangle”). Do not specify beam if specifying major, minor, and pa.