specfit – Fit 1-dimensional gaussians and/or polynomial models to an image or image region – analysis task
Description
Parameters
Parameter |
Default |
Description |
|---|---|---|
imagename |
|
|
box |
|
|
region |
|
|
chans |
|
|
stokes |
|
|
axis |
|
|
mask |
|
|
ngauss |
|
|
poly |
|
|
estimates |
|
|
minpts |
|
|
multifit |
|
|
model |
|
|
residual |
|
|
amp |
|
|
amperr |
|
|
center |
|
|
centererr |
|
|
fwhm |
|
|
fwhmerr |
|
|
integral |
|
|
integralerr |
|
|
wantreturn |
|
|
stretch |
|
|
logresults |
|
|
pampest |
|
|
pcenterest |
|
|
pfwhmest |
|
|
pfix |
|
|
gmncomps |
|
|
gmampcon |
|
|
gmcentercon |
|
|
gmfwhmcon |
|
|
gmampest |
|
|
gmcenterest |
|
|
gmfwhmest |
|
|
gmfix |
|
|
logfile |
|
|
append |
|
|
pfunc |
|
|
goodamprange |
|
|
goodcenterrange |
|
|
goodfwhmrange |
|
|
sigma |
|
|
outsigma |
|
Parameter Explanations
imagename
''
Name of the input image
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.
axis
int(-1)
The profile axis. Default: use the spectral axis if one exists, axis 0 otherwise (<0).
mask
''
Mask to use. Default is none..
ngauss
int(1)
Number of Gaussian elements. Default: 1.
poly
int(-1)
Order of polynomial element. Default: do not fit a polynomial (<0).
estimates
''
Name of file containing initial estimates. Default: No initial estimates (“”).
minpts
int(1)
Minimum number of unmasked points necessary to attempt fit.
multifit
False
If true, fit a profile along the desired axis at each pixel in the specified region. If false, average the non-fit axis pixels and do a single fit to that average profile. Default False.
model
''
Name of model image. Default: do not write the model image (“”).
residual
''
Name of residual image. Default: do not write the residual image (“”).
amp
''
Name of amplitude solution image. Default: do not write the image (“”).
amperr
''
Name of amplitude solution error image. Default: do not write the image (“”).
center
''
Name of center solution image. Default: do not write the image (“”).
centererr
''
Name of center solution error image. Default: do not write the image (“”).
fwhm
''
Name of fwhm solution image. Default: do not write the image (“”).
fwhmerr
''
Name of fwhm solution error image. Default: do not write the image (“”).
integral
''
Prefix of ame of integral solution image. Name of image will have gaussian component number appended. Default: do not write the image (“”).
integralerr
''
Prefix of name of integral error solution image. Name of image will have gaussian component number appended. Default: do not write the image (“”).
wantreturn
True
Should a record summarizing the results be returned?
stretch
False
Stretch the mask if necessary and possible?
logresults
True
Output results to logger?
pampest
''
Initial estimate of PCF profile (gaussian or lorentzian) amplitudes.
pcenterest
''
Initial estimate PCF profile centers, in pixels.
pfwhmest
''
Initial estimate PCF profile FWHMs, in pixels.
pfix
''
PCF profile parameters to fix during fit.
gmncomps
int(0)
Number of components in each gaussian multiplet to fit
gmampcon
''
The amplitude ratio constraints for non-reference components to reference component in gaussian multiplets.
gmcentercon
''
The center offset constraints (in pixels) for non-reference components to reference component in gaussian multiplets.
gmfwhmcon
''
The FWHM ratio constraints for non-reference components to reference component in gaussian multiplets.
gmampest
numpy.array( [ ] )
Initial estimate of individual gaussian amplitudes in gaussian multiplets.
gmcenterest
numpy.array( [ ] )
Initial estimate of individual gaussian centers in gaussian multiplets, in pixels.
gmfwhmest
numpy.array( [ ] )
Initial estimate of individual gaussian FWHMss in gaussian multiplets, in pixels.
gmfix
''
Parameters of individual gaussians in gaussian multiplets to fix during fit.
logfile
''
File in which to log results. Default is not to write a logfile.
append
True
Append results to logfile? Logfile must be specified. Default is to append. False means overwrite existing file if it exists.
pfunc
''
PCF singlet functions to fit. “gaussian” or “lorentzian” (minimal match supported). Unspecified means all gaussians.
goodamprange
numpy.array( [ ] )
Acceptable amplitude solution range. [0.0] => all amplitude solutions are acceptable.
goodcenterrange
numpy.array( [ ] )
Acceptable center solution range in pixels relative to region start. [0.0] => all center solutions are acceptable.
goodfwhmrange
numpy.array( [ ] )
Acceptable FWHM solution range in pixels. [0.0] => all FWHM solutions are acceptable.
sigma
''
Standard deviation array or image name.
outsigma
''
Name of output image used for standard deviation. Ignored if sigma is empty.