AlignRegionToSurfaceCoordinatesFormat


Returns region covering the same area for the surface with another coordinates format.

Applications:Transformation of regions defined on the image associated with the surface to image associated with another surface.

Syntax

C++
C#
Python
 
def AlignRegionToSurfaceCoordinatesFormat(
	inRegion: Region,
	inInputSurfaceCoordinatesFormat: SurfaceCoordinatesFormat,
	inOutputSurfaceCoordinatesFormat: SurfaceCoordinatesFormat,
	outAlignedRegion: Region,
	/,
	*,
	inFrameWidth: int | None = None,
	inFrameHeight: int | None = None
)
-> None

Parameters

Name Type Default Description
Input value inRegion Region Input region
Input value inInputSurfaceCoordinatesFormat SurfaceCoordinatesFormat Offsets and scales on X and Y axes of the surface associated with the image the input region were defined on
Input value inOutputSurfaceCoordinatesFormat SurfaceCoordinatesFormat Offsets and scales on X and Y axes of the surface associated with the image the output region is defined on
Input value inFrameWidth int | None None Output region's frame width
Input value inFrameHeight int | None None Output region's frame height
Output value outAlignedRegion Region