vpi.Image.remap

Image.remap(self: vpi.Image, wmap: vpi.WarpMap, size: Optional[Tuple[int, int]] = None, *, backend: vpi.Backend = vpi.Backend.DEFAULT, out: vpi.Image = None, interp: vpi.Interp = vpi.Interp.LINEAR, border: vpi.Border = vpi.Border.ZERO, stream: vpi.Stream = None) → vpi.Image

Remap the image.

Remaps the input image, effectively warping it using a user-provided mapping.

Hint

In a lens distortion correction context, the output corresponds to the distortion-free image.

See also

Refer to the algorithm explanation for more details and usage examples.

Parameters

  • wmap (vpi.WarpMap) – Mapping of output back into input. It must define a grid with the same size as output image.

  • interp (vpi.Interp) – The interpolation to be used by the algorithm.

  • size (Tuple[int, int], optional) – The output dimensions (width, height).

  • out (vpi.Image, optional) – The output (remapped image) for the algorithm.

  • border (vpi.Border, optional) – What value to pick if remapped coordinated falls outside input image.

  • backend (vpi.Backend, optional) – The backend to be used by the algorithm.

  • stream (vpi.Stream, optional) – The stream to be used by the algorithm.

Returns

The remapped image.

Return type

vpi.Image

Caution

Restrictions to several arguments may apply. Check the C API references of the submit function and the group concepts for more details.