imsubimage – Create a (sub)image from a region of the image – analysis task

Description

Parameters

Title

Parameter

Default

Description

imagename

''

Input image name. Default is unset.

outfile

''

Output image name. Default is unset.

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.

dropdeg

False

Drop degenerate axes

overwrite

False

Overwrite (unprompted) pre-existing output file?

verbose

True

Post additional informative messages to the logger

stretch

False

Stretch the mask if necessary and possible?

keepaxes

numpy.array( [  ] )

If dropdeg=True, these are the degenerate axes to keep. Nondegenerate axes are implicitly always kept.

Parameter Explanations

imagename

''

Input image name. Default is unset.

outfile

''

Output image name. Default is unset.

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.

dropdeg

False

Drop degenerate axes

overwrite

False

Overwrite (unprompted) pre-existing output file?

verbose

True

Post additional informative messages to the logger

stretch

False

Stretch the mask if necessary and possible?

keepaxes

numpy.array( [  ] )

If dropdeg=True, these are the degenerate axes to keep. Nondegenerate axes are implicitly always kept.