You are here: Start » FIL.NET » FIS.ProfileAutocorrelation Method

FIS.ProfileAutocorrelation Method

Computes the correlation between neighboring sub-profiles of different sizes and infers the most probable period length.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

public static void ProfileAutocorrelation
(
	FilNet.Profile inProfile,
	int inStart,
	int inMinPeriod,
	int inMaxPeriod,
	int inMinVerifiedLength,
	bool inFlexibleVerification,
	int inMinRepeatCount,
	float inHarmonicHysteresis,
	FilNet.PeriodPrecisionMethod inPrecisionMethod,
	IList<float> outAutocorrelationValues,
	out float outPeriod,
	out float outPeriodScore
)

Parameters

Name Type Range Default Description
inProfileFilNet.ProfileInput profile.
inStartint<0, INF>Beginning index of the sub-profile of interest.
inMinPeriodint<2, INF>2Minimum period length. Default value: 2.
inMaxPeriodint<2, INF>2Maximum period length. Default value: 2.
inMinVerifiedLengthint<1, INF>1Minimum number of profile points that verify single period (increases the actual RepeatCount for small periods). Default value: 1.
inFlexibleVerificationboolCompensates errors resulting from whole-pixel precision.
inMinRepeatCountint<1, INF>1The number of repeats for sufficiently big periods. Default value: 1.
inHarmonicHysteresisfloat<0.0f, 1.0f>0.05fDefines how much better must be the period T than T/2, T/3 etc. to be accepted. Default value: 0.05f.
inPrecisionMethodFilNet.PeriodPrecisionMethodDefines if and how sub-point precision is achieved.
outAutocorrelationValuesSystem.Collections.Generic.IList<float>Autocorrelation values for consecutive period values.
outPeriodfloatEstimated period length.
outPeriodScorefloatCorrelation value for the estimated period length.

See also