imfit – Fit one or more elliptical Gaussian components on an image region(s) – analysis task

Description

Parameters

Title

Parameter	Default	Description
imagename	''	Name of the input image
box	''	Rectangular region(s) 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 first Stokes plane.
mask	''	Mask to use. Default is none.
includepix	numpy.array( [  ] )	Range of pixel values to include for fitting.
excludepix	numpy.array( [  ] )	Range of pixel values to exclude for fitting.
residual	''	Name of output residual image.
model	''	Name of output model image.
estimates	''	Name of file containing initial estimates of component parameters.
logfile	''	Name of file to write fit results.
append	True	If logfile exists, append to it if True or overwrite it if False
newestimates	''	File to write fit results which can be used as initial estimates for next run.
complist	''	Name of output component list table.
overwrite	False	Overwrite component list table if it exists?
dooff	False	Also fit a zero level offset? Default is False
offset	float(0.0)	Initial estimate of zero-level offset. Only used if doff is True. Default is 0.0
fixoffset	False	Keep the zero level offset fixed during fit? Default is False
stretch	False	Stretch the mask if necessary and possible?
rms	[ ]	RMS to use in calculation of uncertainties. Numeric or valid quantity (record or string). If numeric, it is given units of the input image. If quantity, units must conform to image units. If not positive, the rms of the residual image, in the region of the fit, is used.
noisefwhm	''	Noise correlation beam FWHM. If numeric value, interpreted as pixel widths. If quantity (dictionary, string), it must have angular units.
summary	''	File name to which to write table of fit parameters.

Parameter Explanations

imagename

''

Name of the input image

box

''

Rectangular region(s) 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 first Stokes plane.

mask

''

Mask to use. Default is none.

includepix

numpy.array( [  ] )

Range of pixel values to include for fitting.

excludepix

numpy.array( [  ] )

Range of pixel values to exclude for fitting.

residual

''

Name of output residual image.

model

''

Name of output model image.

estimates

''

Name of file containing initial estimates of component parameters.

logfile

''

Name of file to write fit results.

append

True

If logfile exists, append to it if True or overwrite it if False

newestimates

''

File to write fit results which can be used as initial estimates for next run.

complist

''

Name of output component list table.

overwrite

False

Overwrite component list table if it exists?

dooff

False

Also fit a zero level offset? Default is False

offset

float(0.0)

Initial estimate of zero-level offset. Only used if doff is True. Default is 0.0

fixoffset

False

Keep the zero level offset fixed during fit? Default is False

stretch

False

Stretch the mask if necessary and possible?

rms

[ ]

RMS to use in calculation of uncertainties. Numeric or valid quantity (record or string). If numeric, it is given units of the input image. If quantity, units must conform to image units. If not positive, the rms of the residual image, in the region of the fit, is used.

noisefwhm

''

Noise correlation beam FWHM. If numeric value, interpreted as pixel widths. If quantity (dictionary, string), it must have angular units.

summary

''

File name to which to write table of fit parameters.