AlignRegion


Aligns a region to a coordinate system.

Applications:Most typically used, when there is a region extracted after performing CropImageToRectangle. This filter makes it possible to align the region with the original image.

Syntax

C++
C#
Python
 
def AlignRegion(
	inRegion: Region,
	inAlignment: CoordinateSystem2D,
	outAlignedRegion: Region,
	/,
	*,
	inInverse: bool = False,
	inFrameWidth: int | None = None,
	inFrameHeight: int | None = None
)
-> None

Parameters

Name Type Range Default Description
Input value inRegion Region Input region
Input value inAlignment CoordinateSystem2D Coordinate system to align to
Input value inInverse bool False Switches to the inverse transform
Input value inFrameWidth int | None 0 - 65535 None Output region's frame width
Input value inFrameHeight int | None 0 - 65535 None Output region's frame height
Output value outAlignedRegion Region