Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

image.insert - Function

	Package	general
	Module	images
	Tool	image

Insert specified image into this image

Synopsis
insert(infile, region, locate)

Arguments

infile	in	Image file name or Image tool to insert
		Allowed:	String
		Default:	unset
region	in	The region of interest of the input image
		Allowed:	Region tool
		Default:	Whole image
locate	in	Location of input image in output image
		Allowed:	Vector
		Default:	Centrally located

Returns
Image tool or fail

Description

This function inserts the specified image (or part of it) into this image. The specified image may be given via argument infile as a disk file name (it may be in native AIPS++, FITS, or Miriad format; Look here for more information on foreign images) or directly as an Image tool.

If the locate vector is not given, then the images are aligned (to an integer pixel shift) by their reference pixels.

If locate vector is given, then those values that are given, give the absolute pixel in the output (this) image of the bottom left corner of the input (sub)image. For those values that are not given, the input image is symmetrically placed in the output image.

Example

- dowait := T
- im := imagefromshape(shape=[200,200])
- im.insert(infile='myfile.insert')              # Align by reference pixel
- im.set(0.0)
- im2 := image('myfile.insert')
- im.insert(infile=im2, locate=[])               # Align centrally, specify as Image tool
- im.set(0.0)
- im.insert(infile='myfile.insert', locate=[20]) # Align axis 1 as given and axis 2 centrally