Back to FabImage Library website

You are here: Start » Function Reference » Region » Region Features » RegionMassCenter

RegionMassCenter


Header: FIL.h
Namespace: fil
Module: FoundationLite

Computes a point with coordinates equal to the average coordinates of the region's pixels.

Syntax

C++
C#
 
void fil::RegionMassCenter
(
	const fil::Region& inRegion,
	fil::Point2D& outMassCenter,
	ftl::Optional<int&> outArea = ftl::NIL
)

Parameters

Name Type Default Description
Input value inRegion const Region& Input region
Output value outMassCenter Point2D&
Output value outArea Optional<int&> NIL

Optional Outputs

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

Read more about Optional Outputs.

Description

The operation computes the average of all pixel locations contained in a region. Note that the result is a Point2D, not a Location as its coordinates may be not-integer.

Hints

  • If the input region is not guaranteed to be non-empty, precede this filter with SkipEmptyRegion.

Examples

The resulting outMassCenter point drawn onto the sample region.

Errors

List of possible exceptions:

Error type Description
DomainError Input region is empty in RegionMassCenter.

See Also