Back to FabImage Library website

You are here: Start » Function Reference » All Functions » Array Transforms » SynchronizeArrays

SynchronizeArrays


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: STD.h
Namespace: fil
Module: FoundationLite

Selects as many elements from each of the input arrays as possible, while assuring that the difference between corresponding values is not too big.

Syntax

void fil::SynchronizeArrays
(
	const ftl::Array<Type>& inArray1,
	const ftl::Array<Type>& inArray2,
	const ftl::Array<float>& inValues1,
	const ftl::Array<float>& inValues2,
	const float inMaxDifference,
	ftl::Array<Type>& outArray1,
	ftl::Array<Type>& outArray2
)

Parameters

Name Type Range Default Description
Input value inArray1 const Array<Type>&
Input value inArray2 const Array<Type>&
Input value inValues1 const Array<float>&
Input value inValues2 const Array<float>&
Input value inMaxDifference const float 0.0 -
Output value outArray1 Array<Type>&
Output value outArray2 Array<Type>&

Errors

List of possible exceptions:

Error type Description
DomainError Inconsistent array lengths in SynchronizeArrays.
DomainError inMaxDifference negative in SynchronizeArrays.