GridDescriptiveStatisticsAverageWeightedFigureOfMerit Method (IEnumerableCoverageGridPointWithResults, FigureOfMeritDouble)

Computes the average of a given figure of merit over the grid, based on the grid point Weights.

Namespace: AGI.Foundation.Coverage.FigureOfMerit
Assembly: AGI.Foundation.Spatial (in AGI.Foundation.Spatial.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public static double AverageWeightedFigureOfMerit(
	IEnumerable<CoverageGridPointWithResults> gridPoints,
	FigureOfMerit<double> function
)

Public Shared Function AverageWeightedFigureOfMerit ( 
	gridPoints As IEnumerable(Of CoverageGridPointWithResults),
	function As FigureOfMerit(Of Double)
) As Double

public:
static double AverageWeightedFigureOfMerit(
	IEnumerable<CoverageGridPointWithResults^>^ gridPoints, 
	FigureOfMerit<double>^ function
)

static member AverageWeightedFigureOfMerit : 
        gridPoints : IEnumerable<CoverageGridPointWithResults> * 
        function : FigureOfMerit<float> -> float

Parameters

gridPoints: Type: System.Collections.GenericIEnumerableCoverageGridPointWithResults
The coverage grid points. These points must contain results.
function: Type: AGI.Foundation.Coverage.FigureOfMeritFigureOfMeritDouble
The figure of merit to average.

Return Value

Type: Double
The average of the given figure of merit.

Exceptions

Exception	Condition
InvalidOperationException	Thrown if any of the weight scalars for the input grid points varies in time.

Remarks

This method only works with static grids.

Reference

GridDescriptiveStatistics Class

AverageWeightedFigureOfMerit Overload

AGI.Foundation.Coverage.FigureOfMerit Namespace