Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

imagerpositiontest.set_clean_parms - Function

	Package	synthesis
	Module	synthesistester
	Tool	imagerpositiontest

Set up the parameters for a clean test.

Synopsis
set_clean_parms(algorithm, niter, gain, threshold, displayprogress, fixed)

Description
Set up the parameters for a clean test. The parameters set here are passed to (p)imager.clean() from make_image().

Arguments

algorithm		The clean algorithm to use
		Allowed:	String: 'clark'|'hogbom'|'mfclark'|'mfhogbom'|'wfclark'|'wfhogbom'
		Default:	'clark'
niter		Number of clean iterations
		Allowed:	Integer >= 0
		Default:	1000
gain		Loop gain factor
		Allowed:	Float > 0
		Default:	0.1
threshold		Residual level at which to stop cleaning
		Allowed:	Quantity (flux density)
		Default:	'0Jy'
displayprogress		Display the progress during the clean?
		Allowed:	Boolean
		Default:	F
fixed		Keep one or more models fixed?
		Allowed:	Array of booleans
		Default:	F

Returns
T or fail

Example

- include 'imagerpositiontest.g';
- ipt := imagerpositiontest();
# set up a multifield clark clean test
- ipt.set_deconvolution_function('clean');
- ipt.set_sim_parms(nfields=4);
- ipt.set_clean_parms(algorithm='mfclark',niter=2000,gain=0.15);
T
- ipt.dotests();