map_imagemap_imageMapImageMapImage (Operator)


map_imagemap_imageMapImageMapImage — Apply a general transformation to an image.


map_image(Image, Map : ImageMapped : : )

Herror map_image(const Hobject Image, const Hobject Map, Hobject* ImageMapped)

Herror T_map_image(const Hobject Image, const Hobject Map, Hobject* ImageMapped)

void MapImage(const HObject& Image, const HObject& Map, HObject* ImageMapped)

HImage HImage::MapImage(const HImage& Map) const

static void HOperatorSet.MapImage(HObject image, HObject map, out HObject imageMapped)

HImage HImage.MapImage(HImage map)


map_imagemap_imageMapImageMapImageMapImage transforms an image ImageImageImageImageimage using an arbitrary transformation MapMapMapMapmap which, for example, was previously generated using gen_image_to_world_plane_mapgen_image_to_world_plane_mapGenImageToWorldPlaneMapGenImageToWorldPlaneMapGenImageToWorldPlaneMap or gen_radial_distortion_mapgen_radial_distortion_mapGenRadialDistortionMapGenRadialDistortionMapGenRadialDistortionMap. The multi-channel image MapMapMapMapmap must be organized as follows:

The height and the width of MapMapMapMapmap define the size of the output image ImageMappedImageMappedImageMappedImageMappedimageMapped. The number of channels in MapMapMapMapmap defines whether no interpolation or bilinear interpolation should be used. If MapMapMapMapmap only consists of one channel, no interpolation is applied during the transformation. This channel contains 'int4' (resp. 'int8' in HALCON XL if the value range of 'int4' is not sufficient) values that describe the geometric transformation: For each pixel in the output image ImageMappedImageMappedImageMappedImageMappedimageMapped the linearized coordinate of the pixel in the input image ImageImageImageImageimage from which the gray value should be taken is stored.

If bilinear interpolation between the pixels in the input image should be applied, MapMapMapMapmap must consist of 5 channels. The first channel again consists of an 'int4' resp. 'int8' image and describes the geometric transformation. The channels 2-5 consist of an 'uint2' image each and contain the weights [0...1] of the four neighboring pixels that are used during bilinear interpolation. If the overall brightness of the output image ImageMappedImageMappedImageMappedImageMappedimageMapped should not differ from the overall brightness of the input image ImageImageImageImageimage, the sum of the four unscaled weights must be 1 for each pixel. The weights [0...1] are scaled to the range of values of the 'uint2' image and therefore hold integer values from 0 to 65535.

Furthermore, the weights must be chosen in a way that the range of values of the output image ImageMappedImageMappedImageMappedImageMappedimageMapped is not exceeded. The geometric relation between the four channels 2-5 is illustrated in the following sketch:

2 3
4 5

The reference point of the four pixels is the upper left pixel. The linearized coordinate of the reference point is stored in the first channel.

It is also possible to use a MapMapMapMapmap that consists of a vector field containing absolute subpixel precise row and column coordinates (i.e., the field must be of the semantic type 'vector_field_absolute'). The two MapMapMapMapmap types described above can be converted into this type using convert_map_typeconvert_map_typeConvertMapTypeConvertMapTypeConvertMapType. This type is the only type supported on compute devices!


The weights must be chosen in a way that the range of values of the output image ImageMappedImageMappedImageMappedImageMappedimageMapped is not exceeded.

For runtime reasons during the mapping process, it is not checked whether the linearized coordinates which are stored in the first channel of MapMapMapMapmap, lie inside the input image. Thus, it must be ensured by the user that this constraint is fulfilled. Otherwise, the program may crash!

map_imagemap_imageMapImageMapImageMapImage is parallelized automatically if and only if MapMapMapMapmap uses bilinear interpolation. map_imagemap_imageMapImageMapImageMapImage is executed on an OpenCL compute device only if the input map is of type 'coord_map_sub_pix' and if the input image does not exceed the maximum size of image objects of the selected device.

Execution Information


ImageImageImageImageimage (input_object)  (multichannel-)image(-array) objectHImageHImageHobject (byte / uint2 / real)

Image to be mapped.

MapMapMapMapmap (input_object)  (multichannel-)image objectHImageHImageHobject (int4 / int8 / uint2 / vector_field*) *allowed for compute devices

Image containing the mapping data.

ImageMappedImageMappedImageMappedImageMappedimageMapped (output_object)  (multichannel-)image(-array) objectHImageHImageHobject * (byte / uint2 / real)

Mapped image.


map_imagemap_imageMapImageMapImageMapImage returns 2 (H_MSG_TRUE) if all parameter values are correct. If necessary, an exception is raised.

Possible Predecessors

gen_image_to_world_plane_mapgen_image_to_world_plane_mapGenImageToWorldPlaneMapGenImageToWorldPlaneMapGenImageToWorldPlaneMap, gen_radial_distortion_mapgen_radial_distortion_mapGenRadialDistortionMapGenRadialDistortionMapGenRadialDistortionMap, convert_map_typeconvert_map_typeConvertMapTypeConvertMapTypeConvertMapType

See also

affine_trans_imageaffine_trans_imageAffineTransImageAffineTransImageAffineTransImage, rotate_imagerotate_imageRotateImageRotateImageRotateImage