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

CropProfileValues

Header:	FIL.h
Namespace:	fil

Applies limits to profile values.

Syntax

void fil::CropProfileValues
(
	fil::Profile& ioProfile,
	ftl::Optional<const fil::Range&> inRange,
	const ftl::Optional<float> inLowValue,
	const ftl::Optional<float> inHighValue
)

Parameters

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

Errors

List of possible exceptions:

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