Back to Adaptive Vision Library website

You are here: Start » Function Reference » Region » Region Spatial Transforms » TrimRegionToRectangle

TrimRegionToRectangle


Header: AVL.h
Namespace: avl
Module: FoundationPro

Limits a region to a rectangular area.

Syntax

C++
C#
 
void avl::TrimRegionToRectangle
(
	const avl::Region& inRegion,
	const avl::Rectangle2D& inRectangle,
	atl::Optional<const avl::CoordinateSystem2D&> inRectangleAlignment,
	avl::Region& outRegion,
	atl::Optional<avl::Rectangle2D&> outAlignedRectangle = atl::NIL
)

Parameters

Name Type Default Description
inRegion const Region& Input region
inRectangle const Rectangle2D& Trimming rectangle
inRectangleAlignment Optional<const CoordinateSystem2D&> NIL Adjusts the rectangle to the position of the inspected object
outRegion Region& Output region
outAlignedRectangle Optional<Rectangle2D&> NIL Input rectangle after transformation (in the region coordinates)

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outAlignedRectangle.

Read more about Optional Outputs.