Back to FabImage Library website

You are here: Start » Function Reference » Profile » Profile Local Transforms » DifferentiateProfile

DifferentiateProfile


Header: FIL.h
Namespace: fil
Module: FoundationPro

Computes the derivative of a profile.

Syntax

C++
C#
 
void fil::DifferentiateProfile
(
	const fil::Profile& inProfile,
	const bool inCyclic,
	fil::DifferentiationMethod::Type inDifferentiationMethod,
	fil::Profile& outDerivative
)

Parameters

Name Type Default Description
Input value
 inProfile const Profile& Input profile
Input value
 inCyclic const bool Defines whether to compute differences between first and last elements
Input value
 inDifferentiationMethod DifferentiationMethod::Type Central
Output value
 outDerivative Profile&

Description

Computes finite difference of profile using forward, backward or central difference method. If inCyclic is False then depending of chosen difference method values for first or last element of inProfile is undefined and thus outermost values are doubled when necessary.

For instance, in forward difference method, last element of derivative profile is always zero. In backward difference method, first element is always zero.

Examples

On the left DifferentiateProfile with inCyclic = False, inDifferentiationMethod = Forward performed on profile being shown on the right.