image.modify - Function

Modify image with a model

Synopsis
modify(model, region, mask, subtract, list, async)

Arguments

model	in	The model
		Allowed:	Componentlist tool
region	in	The 2-D region of interest
		Allowed:	Region tool
		Default:	Whole image
mask	in	OTF mask
		Allowed:	Boolean LEL expression or mask region
		Default:	None
subtract	in	Subtract or add the model
		Allowed:	T or F
		Default:	T
list	in	List informative messages to the logger
		Allowed:	T or F
		Default:	T
async	in	Run asynchronously?
		Allowed:	Bool
		Default:	!dowait

Returns
T or fail

Description

This function applies a model of the sky to the image. You can add or subtract the model which is contained in a Componentlist tool.

The pixel values are only changed where the total mask (combination of the default pixel mask [if any] and the OTF mask) is good (True). If the computation fails for a particular pixel (e.g. coordinate undefined) that pixel will be masked bad.

Example

- myim := image('gc.small')
- cl := componentlist('list')
- myim.modify(cl)

In this example we subtract the model contained in the Table called list.

Next: image.maxfit - Function Up: image - Tool Previous: image.miscinfo - Function Contents Index

	Package	general
	Module	images
	Tool	image