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

CreateRegionOfInterestRegion

Header:	FIL.h
Namespace:	fil

Creates a region corresponding to a given region of interest.

Syntax

void fil::CreateRegionOfInterestRegion
(
	const fil::RegionOfInterest& inRegionOfInterest,
	ftl::Optional<const fil::CoordinateSystem2D&> inAlignment,
	int inFrameWidth,
	int inFrameHeight,
	fil::Region& outRegion
)

Parameters

Name	Type	Range	Default	Description
inRegionOfInterest	const RegionOfInterest&
inAlignment	Optional<const CoordinateSystem2D&>		NIL	Adjusts the region of interest to the position of the inspected object
inFrameWidth	int	0 - 65535		Width of the created region's frame
inFrameHeight	int	0 - 65535		Height of the created region's frame
outRegion	Region&			Output region

Errors

List of possible exceptions:

Error type	Description
DomainError	Invalid RegionOfInterest in CreateRegionOfInterestRegion.