Back to FabImage Library website

You are here: Start » Function Reference » Profile » Profile Point Transforms » ClipProfileValues

ClipProfileValues


Header: FIL.h
Namespace: fil
Module: FoundationPro

Applies limits to profile values.

Syntax

C++
C#
 
void fil::ClipProfileValues
(
	fil::Profile& ioProfile,
	ftl::Optional<const fil::Range&> inRange,
	const ftl::Optional<float> inLowValue,
	const ftl::Optional<float> inHighValue
)

Parameters

Name Type Default Description
Input will be modified
 ioProfile Profile&
Input value
 inRange Optional<const Range&> NIL
Input value
 inLowValue const Optional<float> NIL Value min threshold
Input value
 inHighValue const Optional<float> NIL Value max threshold

Errors

List of possible exceptions:

Error type Description
DomainError Range exceeds the input profile in ClipProfileValues.
DomainError Value of inHighValue is less than inLowValue in ClipProfileValues.