Back to FabImage Library website

You are here: Start » Function Reference » Profile » Profile Basics » GetProfileValue

GetProfileValue


Header: FIL.h
Namespace: fil
Module: FoundationPro

Gets a single value from a profile, located at the specified X (real-world) coordinate.

Syntax

C++
C#
 
void fil::GetProfileValue
(
	const fil::Profile& inProfile,
	float inX,
	bool inSmooth,
	float& outValue
)

Parameters

Name Type Default Description
Input value
 inProfile const Profile& Input profile
Input value
 inX float X coordinate at which the profile value is calculated
Input value
 inSmooth bool Determines whether an interpolation between two profile elements should be smooth
Output value
 outValue float&

Errors

List of possible exceptions:

Error type Description
DomainError Empty profile on input in GetProfileValue.
DomainError X coordinate out of range in GetProfileValue.