imregrid – regrid an image onto a template image – analysis task

Description

Imregrid will regrid an input image onto a new coordinate system from a template image or to a new directional reference frame. If a template image is used, then the input and template images must have the same coordinate structure.

Parameters

Title

Parameter	Default	Description
imagename	''	Name of the source image
template	'get'	A dictionary, refcode, or name of an image that provides the output shape and coordinate system
output	''	Name for the regridded image
asvelocity	True	Regrid spectral axis in velocity space rather than frequency space?
axes	numpy.array( [  ] )	The pixel axes to regrid. -1 => all.
shape	numpy.array( [  ] )	Shape of the output image. Only used if template is an image. If not specified (-1), the output image shape will be the same as the template image shape along the axes that are regridded and the same as input image shape along the axes which are not regridded.
interpolation	'linear'	The interpolation method. One of “nearest”, “linear”, “cubic”.
decimate	int(10)	Decimation factor for coordinate grid computation
replicate	False	Replicate image rather than regrid?
overwrite	False	Overwrite (unprompted) pre-existing output file?

Parameter Explanations

imagename

''

Name of the source image

template

'get'

A dictionary, refcode, or name of an image that provides the output shape and coordinate system

output

''

Name for the regridded image

asvelocity

True

Regrid spectral axis in velocity space rather than frequency space?

axes

numpy.array( [  ] )

The pixel axes to regrid. -1 => all.

shape

numpy.array( [  ] )

Shape of the output image. Only used if template is an image. If not specified (-1), the output image shape will be the same as the template image shape along the axes that are regridded and the same as input image shape along the axes which are not regridded.

interpolation

'linear'

The interpolation method. One of “nearest”, “linear”, “cubic”.

decimate

int(10)

Decimation factor for coordinate grid computation

replicate

False

Replicate image rather than regrid?

overwrite

False

Overwrite (unprompted) pre-existing output file?