CircularDescriptiveStatisticsDispersionAboutAngle Method

Calculates the dispersion of a list of angles about a given angle.

Namespace: AGI.Foundation
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

public static double DispersionAboutAngle(
	IList<double> dataList,
	double angle
)

Public Shared Function DispersionAboutAngle ( 
	dataList As IList(Of Double),
	angle As Double
) As Double

public:
static double DispersionAboutAngle(
	IList<double>^ dataList, 
	double angle
)

static member DispersionAboutAngle : 
        dataList : IList<float> * 
        angle : float -> float

dataList: Type: System.Collections.GenericIListDouble
The list of angles to use to calculate the dispersion.
angle: Type: SystemDouble
The angle around which dispersion is measured.

Type: Double
The measure of how the data points are dispersed about the given angle.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when dataList is .
ArgumentException	Thrown when dataList is empty.

Remarks

The output range is [0, π]. Winding is ignored.

CircularDescriptiveStatisticsAddLanguageSpecificTextSet("LSTC00990E5_0?cpp=::|nu=.");DispersionAboutAngle Method