Back to FabImage Library website

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

CreateCircleRegion


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates a circular region corresponding to a given circle.

Syntax

C++
C#
 
void fil::CreateCircleRegion
(
	const fil::Circle2D& inCircle,
	ftl::Optional<const fil::CoordinateSystem2D&> inCircleAlignment,
	int inFrameWidth,
	int inFrameHeight,
	fil::Region& outRegion,
	ftl::Optional<fil::Circle2D&> outAlignedCircle = ftl::NIL
)

Parameters

Name Type Range Default Description
Input value
 inCircle const Circle2D&
Input value
 inCircleAlignment Optional<const CoordinateSystem2D&> NIL Adjusts the circle to the position of the inspected object
Input value
 inFrameWidth int 0 - 65535 Width of the created region's frame (not to be confused with the size of the circle!)
Input value
 inFrameHeight int 0 - 65535 Height of the created region's frame (not to be confused with the size of the circle!)
Output value
 outRegion Region& Output region
Output value
 outAlignedCircle Optional<Circle2D&> NIL The input circle 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: outAlignedCircle.

Read more about Optional Outputs.

Description

The operation creates a region containing pixels lying inside the given circle.

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 circle exceeds these dimensions, the output region will be cropped.

Hints

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

Examples

CreateCircleRegion run with inCircle = Circle2D(150,150,100).

See Also