Back to FabImage Library website

You are here: Start » Function Reference » Path » Path Classification » GetMinimumPath_OrNil

GetMinimumPath_OrNil


Header: FIL.h
Namespace: fil
Module: FoundationBasic

Returns the path from the input array that corresponds to the smallest computed feature value; returns NIL if the array or any path inside it is empty.

Applications: Use this filter when you have an array of paths and you want to select one of them that best matches some criterion.

Syntax

C++
C#
 
void fil::GetMinimumPath_OrNil
(
	const ftl::Array<fil::Path>& inPaths,
	fil::PathFeature::Type inFeature,
	ftl::Conditional<fil::Path>& outPath,
	ftl::Conditional<float>& outValue,
	ftl::Conditional<int>& outIndex
)

Parameters

Name Type Default Description
Input value inPaths const Array<Path>& Input paths
Input value inFeature PathFeature::Type Path feature value to be computed
Output value outPath Conditional<Path>& Output path
Output value outValue Conditional<float>& Computed feature value of the output path
Output value outIndex Conditional<int>&