imcollapse – Collapse image along one axis, aggregating pixel values along that axis. – analysis task

Description

Parameters

Title

Parameter	Default	Description
imagename	''
function	''
axes	[ ]
outfile	''
box	''
region	''
chans	''
stokes	''
mask	''
overwrite	False
stretch	False

Parameter Explanations

imagename

''

Name of the input image

function

''

Aggregate function to apply. This can be set one of flux, madm, max, mean, median, min, npts, rms, stddev, sum, variance, xmadm. Must be specified.

axes

[ ]

Zero-based axis number(s) or minimal match strings to collapse.

outfile

''

Name of output CASA image. Must be specified.

box

''

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

region

''

Region selection. Default is to use the full image.

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.

overwrite

False

Overwrite output image if it exists?

stretch

False

Stretch the mask if necessary and possible?