imageprofilefitter - Constructor

Construct an imageprofilefitter

Synopsis
imageprofilefitter(infile, infile2, sigma, parent, axis, plotter, showimage, widgetset)

Arguments

infile	in	The primary image file name or image tool
		Allowed:	String or Image tool
infile2	in	The secondary image file name or image tool
		Allowed:	String or Image tool
		Default:	Auto generate
sigma	in	Weights image
		Allowed:	String
		Default:	None
parent	in	Parent frame to embed GUI in
		Allowed:	Tk frame agent
		Default:	F
axis	in	Profile pixel axis
		Allowed:	Integer
		Default:	Spectral
plotter	in	The plotter for profile plots
		Allowed:	unset or a pgplotter tool
		Default:	Will create its own
showimage	in	Display the image ?
		Allowed:	T or F
		Default:	T
widgetset	in	The widgetset to use for the GUI
		Allowed:	A widgetserver tool
		Default:	ddlws

Returns
imageprofilefitter tool

Description

This constructor creates the primary GUI. You must specify the primary image via the infile argument. The secondary image specified by infile2 is optional. If you give it, this is the image that is displayed from which you indicate which profiles to fit. If you don't give it, it is generated automatically from the primary image by averaging the data over the profile axis with a 3 - $\sigma$ clip applied. You can specify the input images either by their file names or by giving an image tool.

You may specify a fitting weights image via argument sigma. It must have the same shape as the primary image. If you don't give it, all pixels have the same weight in the fitting process.

The profile axis is specified by the axis argument. If you leave it unset, then the spectral axis, if there is one, is selected. Otherwise axis 3 is selected.

You may optionally embed the display in an existing Tk frame (parent) if you wish.

By default, the Pgplotter tool that is used to display the profiles is created for you. But you may wish to pass in your own plotter (perhaps it's embedded in some other GUI). If so, use the plotter argument to pass in a Pgplotter tool.

Finally, showimage, when set to F, instructs the Imageprofilefitter not to display the image. This means you cannot select profiles interactively. What happens then is that the current image (set in the constructor or via function setimage) is used to generate a profile averaged over the entire image (for the non-profile axes).

Example

- pf := imageprofilefitter(infile='ngc1313.cube', infile2='locate.image', axis=3)
- pf.done()

Next: imageprofilefitter.getestimate - Function Up: imageprofilefitter - Tool Previous: imageprofilefitter - Tool Contents Index

	Package	general
	Module	images
	Tool	imageprofilefitter