Back to FabImage Library website

You are here: Start » Function Reference » Path » Path Combinators » AveragePath

AveragePath


Header: FIL.h
Namespace: fil
Module: FoundationLite

Computes the average of two paths (of equal size and type) point by point.

Syntax

C++
C#
 
void fil::AveragePath
(
	const fil::Path& inPath1,
	const fil::Path& inPath2,
	fil::Path& outPath
)

Parameters

Name Type Default Description
Input value
 inPath1 const Path& Input path
Input value
 inPath2 const Path& Input path
Output value
 outPath Path& Output path

In-place Processing

This function supports in-place data processing - you can pass the same reference to inPath1 and outPath, inPath2 and outPath

Read more about In-place Computation.

Description

The operation computes the average of two paths of equal size and type (open/closed). Each point of the resulting path is an average of the corresponding points in the input paths.

Examples

AveragePath run on the sample paths.

Errors

List of possible exceptions:

Error type Description
DomainError Input paths have unequal size in AveragePath.
DomainError Open/closed paths mismatch in AveragePath.