Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

imagefitter.componentlist - Function

	Package	general
	Module	images
	Tool	imagefitter

Recover the fitted components

Synopsis
componentlist(which, concatenate, deconvolve)

Arguments

which	in	Which fit ?
		Allowed:	Unset or integer
		Default:	All
concatenate	in	Concatenate all Componentlists into one ?
		Allowed:	T or F
		Default:	F
deconvolve	in	Deconvolve components from restoring beam
		Allowed:	T or F
		Default:	F

Returns
Record of Componentlists, Componentlist or fail

Description

The Imagefitter stores the fitted Sky components in an internal record. For each accepted fit, there is one entry in the record (indexed 1, 2, 3 ...) and each entry holds a Componentlist tool; there may be any number of components in each Componentlist (depends upon how many components you fitted). If there are no accepted fits, it returns an empty record and issues a warning.

By default, this function returns the record holding all of the separate Componentlists. If you do specify which (the integer index of the accepted fit) then it returns the Componentlist tool for that index directly.

If you leave which unset (its default), but you specify concatenate=T, then all the Componentlists are concatenated into one, and that concatenated Componentlist tool is returned directly. The concatenate argument is meaningless if you do specify a particular index with which (see above).

You may also optionally deconvolve the components from the restoring beam of the image if there is one. The default is not to do this.

Example

- myfitter := imagefitter(infile='ngc1313.cube')
- list := myfitter.componentlist()                        # Recovers record of Componentlist tools
- print list[1].length()                                  # Length (number components) of 
3                                                         # first Componentlist
#
- cl := myfitter.componentlist(which=3)                   # Recovers specific Componentlist
- print cl.length()
2                  
-
- cld := myfitter.componentlist(which=2, deconvolve=T)    # FIt 2 and deconvolve from beam