Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

imagerpositiontest.set_clean_mask - Function

	Package	synthesis
	Module	synthesistester
	Tool	imagerpositiontest

Specify how the clean mask should be set.

Synopsis
set_clean_mask(type)

Description
When the test is to be carried out using clean, this specifies how the clean mask should be set. There are two recognized settngs. The default, 'all' means to not use a mask when cleaning. 'comps' means to search only the area around the simulated components (a mask image corresponding to this request is created by make_image() by calling make_model_image()).

Arguments

type		The mask type to use when cleaning
		Allowed:	String: 'all'|'comps'
		Default:	'all'

Returns
T or fail

Example

- include 'imagerpositiontest.g';
- ipt := imagerpositiontest();
- ipt.set_deconvolution_function('clean');
# search for clean components only in the areas around the simulated sources
- ipt.set_clean_mask('comps');
T
- ipt.dotests();