You are here: Start » Function Reference » Region » Region Basics » CreateRectangleRegion

CreateRectangleRegion

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

Creates a region corresponding to a given rectangle.

Syntax

void fil::CreateRectangleRegion
(
	const fil::Rectangle2D& inRectangle,
	ftl::Optional<const fil::CoordinateSystem2D&> inRectangleAlignment,
	int inFrameWidth,
	int inFrameHeight,
	fil::Region& outRegion,
	ftl::Optional<fil::Rectangle2D&> outAlignedRectangle = ftl::NIL
)

Parameters

Name	Type	Range	Default	Description
inRectangle	const Rectangle2D&
inRectangleAlignment	Optional<const CoordinateSystem2D&>		NIL	Adjusts the rectangle to the position of the inspected object
inFrameWidth	int	0 - 65535		Width of the created region's frame (not to be confused with the width of the rectangle!)
inFrameHeight	int	0 - 65535		Height of the created region's frame (not to be confused with the height of the rectangle!)
outRegion	Region&			Output region
outAlignedRectangle	Optional<Rectangle2D&>		NIL	The input rectangle transformed to the absolute coordinate system

Optional Outputs

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

Description

The operation creates a region containing pixels lying inside the specified rectangle.

The inFrameWidth and inFrameHeight parameters most often should be set equal to the dimensions of the image this region will be used with. If the input rectangle exceeds these dimensions, the output region will be cropped.

Hints

Remember to set inFrameWidth and inFrameHeight inputs to specify the region frame.