ClassesClassesClassesClasses | | | | Operators

map_imagemap_imageMapImagemap_imageMapImageMapImage (Operator)


map_imagemap_imageMapImagemap_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)

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

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

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

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

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

void HOperatorSetX.MapImage(
[in] IHUntypedObjectX* Image, [in] IHUntypedObjectX* Map, [out] IHUntypedObjectX*ImageMapped)

IHImageX* HImageX.MapImage([in] IHImageX* Map)

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

HImage HImage.MapImage(HImage map)


map_imagemap_imageMapImagemap_imageMapImageMapImage transforms an image ImageImageImageImageImageimage using an arbitrary transformation MapMapMapMapMapmap which, for example, was previously generated using gen_image_to_world_plane_mapgen_image_to_world_plane_mapGenImageToWorldPlaneMapgen_image_to_world_plane_mapGenImageToWorldPlaneMapGenImageToWorldPlaneMap or gen_radial_distortion_mapgen_radial_distortion_mapGenRadialDistortionMapgen_radial_distortion_mapGenRadialDistortionMapGenRadialDistortionMap. The multi-channel image MapMapMapMapMapmap must be organized as follows:

The height and the width of MapMapMapMapMapmap define the size of the output image ImageMappedImageMappedImageMappedImageMappedImageMappedimageMapped. The number of channels in MapMapMapMapMapmap defines whether no interpolation or bilinear interpolation should be used. If MapMapMapMapMapmap 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 ImageMappedImageMappedImageMappedImageMappedImageMappedimageMapped the linearized coordinate of the pixel in the input image ImageImageImageImageImageimage from which the gray value should be taken is stored.

If bilinear interpolation between the pixels in the input image should be applied, MapMapMapMapMapmap 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 ImageMappedImageMappedImageMappedImageMappedImageMappedimageMapped should not differ from the overall brightness of the input image ImageImageImageImageImageimage, 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 ImageMappedImageMappedImageMappedImageMappedImageMappedimageMapped 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 MapMapMapMapMapmap 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 MapMapMapMapMapmap types described above can be converted into this type using convert_map_typeconvert_map_typeConvertMapTypeconvert_map_typeConvertMapTypeConvertMapType. 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 ImageMappedImageMappedImageMappedImageMappedImageMappedimageMapped 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 MapMapMapMapMapmap, 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_imageMapImagemap_imageMapImageMapImage is parallelized automatically if and only if MapMapMapMapMapmap uses bilinear interpolation. map_imagemap_imageMapImagemap_imageMapImageMapImage 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.



ImageImageImageImageImageimage (input_object)  (multichannel-)image(-array) objectHImageHImageHImageHImageXHobject (byte / uint2 / real)

Image to be mapped.

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

Image containing the mapping data.

ImageMappedImageMappedImageMappedImageMappedImageMappedimageMapped (output_object)  (multichannel-)image(-array) objectHImageHImageHImageHImageXHobject * (byte / uint2 / real)

Mapped image.


map_imagemap_imageMapImagemap_imageMapImageMapImage 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_mapGenImageToWorldPlaneMapgen_image_to_world_plane_mapGenImageToWorldPlaneMapGenImageToWorldPlaneMap, gen_radial_distortion_mapgen_radial_distortion_mapGenRadialDistortionMapgen_radial_distortion_mapGenRadialDistortionMapGenRadialDistortionMap, convert_map_typeconvert_map_typeConvertMapTypeconvert_map_typeConvertMapTypeConvertMapType

See also

affine_trans_imageaffine_trans_imageAffineTransImageaffine_trans_imageAffineTransImageAffineTransImage, rotate_imagerotate_imageRotateImagerotate_imageRotateImageRotateImage



ClassesClassesClassesClasses | | | | Operators