Operator Reference

gen_arbitrary_distortion_mapT_gen_arbitrary_distortion_mapGenArbitraryDistortionMapGenArbitraryDistortionMapgen_arbitrary_distortion_map (Operator)

gen_arbitrary_distortion_mapT_gen_arbitrary_distortion_mapGenArbitraryDistortionMapGenArbitraryDistortionMapgen_arbitrary_distortion_map — Generate a projection map that describes the mapping between an arbitrarily distorted image and the rectified image.

Signature

gen_arbitrary_distortion_map( : Map : GridSpacing, Row, Column, GridWidth, ImageWidth, ImageHeight, MapType : )

Herror T_gen_arbitrary_distortion_map(Hobject* Map, const Htuple GridSpacing, const Htuple Row, const Htuple Column, const Htuple GridWidth, const Htuple ImageWidth, const Htuple ImageHeight, const Htuple MapType)

void GenArbitraryDistortionMap(HObject* Map, const HTuple& GridSpacing, const HTuple& Row, const HTuple& Column, const HTuple& GridWidth, const HTuple& ImageWidth, const HTuple& ImageHeight, const HTuple& MapType)

static HImage HMisc::GenArbitraryDistortionMap(Hlong GridSpacing, const HTuple& Row, const HTuple& Column, Hlong GridWidth, Hlong ImageWidth, Hlong ImageHeight, const HString& MapType)

static HImage HMisc::GenArbitraryDistortionMap(Hlong GridSpacing, const HTuple& Row, const HTuple& Column, Hlong GridWidth, Hlong ImageWidth, Hlong ImageHeight, const char* MapType)

static HImage HMisc::GenArbitraryDistortionMap(Hlong GridSpacing, const HTuple& Row, const HTuple& Column, Hlong GridWidth, Hlong ImageWidth, Hlong ImageHeight, const wchar_t* MapType)   ( Windows only)

static void HOperatorSet.GenArbitraryDistortionMap(out HObject map, HTuple gridSpacing, HTuple row, HTuple column, HTuple gridWidth, HTuple imageWidth, HTuple imageHeight, HTuple mapType)

static HImage HMisc.GenArbitraryDistortionMap(int gridSpacing, HTuple row, HTuple column, int gridWidth, int imageWidth, int imageHeight, string mapType)

def gen_arbitrary_distortion_map(grid_spacing: int, row: Sequence[float], column: Sequence[float], grid_width: int, image_width: int, image_height: int, map_type: str) -> HObject

Description

gen_arbitrary_distortion_mapgen_arbitrary_distortion_mapGenArbitraryDistortionMapGenArbitraryDistortionMapgen_arbitrary_distortion_map computes the mapping MapMapMapmapmap between an arbitrarily distorted image and the rectified image. The coordinates RowRowRowrowrow and ColumnColumnColumncolumncolumn describe a distorted grid, which will be mapped onto a regular grid in the rectified image. The coordinates of the (distorted) grid points must be passed line by line in RowRowRowrowrow and ColumnColumnColumncolumncolumn. GridWidthGridWidthGridWidthgridWidthgrid_width is the width of the point grid in grid points. GridSpacingGridSpacingGridSpacinggridSpacinggrid_spacing is the distance between two adjacent grid points in the rectified image. Because the grid points are always mapped to the centers of their corresponding pixels a grid cell requires (GridSpacingGridSpacingGridSpacinggridSpacinggrid_spacing+1) x (GridSpacingGridSpacingGridSpacinggridSpacinggrid_spacing+1) pixels in the rectified image. Note however, that, of course, adjacent grid cells overlap by one pixel.

To compute the mapping MapMapMapmapmap, additionally the width ImageWidthImageWidthImageWidthimageWidthimage_width and height ImageHeightImageHeightImageHeightimageHeightimage_height of the images to be rectified must be passed.

MapTypeMapTypeMapTypemapTypemap_type is used to specify the type of the output MapMapMapmapmap. If 'bilinear'"bilinear""bilinear""bilinear""bilinear" interpolation is chosen, MapMapMapmapmap consists of one image containing five channels. In the first channel for each pixel in the resulting image the linearized coordinates of the pixel in the input image is stored that is in the upper left position relative to the transformed coordinates. The four other channels contain the weights of the four neighboring pixels of the transformed coordinates which are used for the bilinear interpolation, in the following order:

2 3
4 5

The second channel, for example, contains the weights of the pixels that lie to the upper left relative to the transformed coordinates. If 'coord_map_sub_pix'"coord_map_sub_pix""coord_map_sub_pix""coord_map_sub_pix""coord_map_sub_pix" is chosen, MapMapMapmapmap consists of one vector field image, in which for each pixel of the resulting image the subpixel precise coordinates in the input image are stored.

As mentioned above, four adjacent pixels in the distorted image are required to interpolate the gray value of one pixel in the mapped image. If at least one of these pixels is located outside of the distorted image the gray value can not be calculated. The domain of the resulting MapMapMapmapmap domain is reduced accordingly.

In contrary to gen_grid_rectification_mapgen_grid_rectification_mapGenGridRectificationMapGenGridRectificationMapgen_grid_rectification_map, gen_arbitrary_distortion_mapgen_arbitrary_distortion_mapGenArbitraryDistortionMapGenArbitraryDistortionMapgen_arbitrary_distortion_map is used when the coordinates (RowRowRowrowrow,ColumnColumnColumncolumncolumn) of the grid points in the distorted image are already known or the relevant part of the image consist of regular grid structures, which the coordinates can be derived from.

If you want to re-use the created map in another program, you can save it as a multi-channel image with the operator write_imagewrite_imageWriteImageWriteImagewrite_image, using the format 'tiff'"tiff""tiff""tiff""tiff".

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

MapMapMapmapmap (output_object)  multichannel-image objectHImageHObjectHObjectHobject * (int4 / uint2 / vector_field)

Image containing the mapping data.

GridSpacingGridSpacingGridSpacinggridSpacinggrid_spacing (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Distance of the grid points in the rectified image.

Restriction: GridSpacing > 0

RowRowRowrowrow (input_control)  point.y-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Row coordinates of the grid points in the distorted image.

ColumnColumnColumncolumncolumn (input_control)  point.x-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Column coordinates of the grid points in the distorted image.

Restriction: number(Row) == number(Column)

GridWidthGridWidthGridWidthgridWidthgrid_width (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Width of the point grid (number of grid points).

ImageWidthImageWidthImageWidthimageWidthimage_width (input_control)  extent.x HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Width of the images to be rectified.

Restriction: ImageWidth > 0

ImageHeightImageHeightImageHeightimageHeightimage_height (input_control)  extent.y HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Height of the images to be rectified.

Restriction: ImageHeight > 0

MapTypeMapTypeMapTypemapTypemap_type (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Type of mapping.

Default: 'bilinear' "bilinear" "bilinear" "bilinear" "bilinear"

List of values: 'bilinear'"bilinear""bilinear""bilinear""bilinear", 'coord_map_sub_pix'"coord_map_sub_pix""coord_map_sub_pix""coord_map_sub_pix""coord_map_sub_pix"

Result

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

Possible Successors

map_imagemap_imageMapImageMapImagemap_image

See also

create_rectification_gridcreate_rectification_gridCreateRectificationGridCreateRectificationGridcreate_rectification_grid, find_rectification_gridfind_rectification_gridFindRectificationGridFindRectificationGridfind_rectification_grid, connect_grid_pointsconnect_grid_pointsConnectGridPointsConnectGridPointsconnect_grid_points, gen_grid_rectification_mapgen_grid_rectification_mapGenGridRectificationMapGenGridRectificationMapgen_grid_rectification_map

Module

Calibration