Horus Doc || Global Function Guide || General documentation   | Function documentation  

HxExtendVal

Synopsis

HxImageRep HxExtendVal (HxImageRep img, HxSizes newSize, HxValue background, HxPoint begin)

Input

HxImageRep img
The image that you want to place in a larger image.

HxSizes newSize
The size of the new image.

HxValue background
The value of the background of the new image, where the background is that part of the image that does not originate from the input image.

HxPoint begin
The position of the upperleft corner of the image `img' in the background image.

Return value

HxImageRep
The background image (as described by `newSize' and `background') with the image img overlayed at position `begin'.

Description

The function HxExtendVal places the image img in the background image at position `begin', i.e. the upperleft corner of image img is placed at position `begin'. The background image has a constant value `background' and its size is as described by `newSize'.

Remarks

Valid image types
The images img and the image constructed from `newSize' and `background' should have the same dimensionality and the same pixel dimensionality.

Valid values for `newSize' and `background'
The size of the background image, `newSize', should be larger then the image size for every dimension. `newSize' should have the same dimensionality as the input image. The value `background' should have the same dimensionality as the pixel dimensionality of the input image.

Valid values for `begin'
`begin' should be a valid position in the background image.

Valid size for image img
The size of image img should be such that all pixels have a valid position in the background image, when placing the upperleft corner of the image at position `begin' in the background image.

See also

HxExtend, HxRestrict,

Keywords

Geometric,


Generated on Mon Jan 27 15:45:00 2003 for GlobalFunctionGuide by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001