GridDescriptiveStatisticsWeightOfCoveredPoints Method |
Computes the total weight of the points on the grid which have been covered.
Namespace:
AGI.Foundation.Coverage.FigureOfMerit
Assembly:
AGI.Foundation.Spatial (in AGI.Foundation.Spatial.dll) Version: 25.2.423.0 (25.2.423.0)
Syntaxpublic static double WeightOfCoveredPoints(
IEnumerable<CoverageGridPointWithResults> gridPoints
)
Public Shared Function WeightOfCoveredPoints (
gridPoints As IEnumerable(Of CoverageGridPointWithResults)
) As Double
public:
static double WeightOfCoveredPoints(
IEnumerable<CoverageGridPointWithResults^>^ gridPoints
)
static member WeightOfCoveredPoints :
gridPoints : IEnumerable<CoverageGridPointWithResults> -> float
Parameters
- gridPoints
- Type: System.Collections.GenericIEnumerableCoverageGridPointWithResults
The coverage grid points. These points must contain results.
Return Value
Type:
DoubleThe total weight of the covered grid points.
Exceptions| Exception | Condition |
|---|
| InvalidOperationException | Thrown if any of the weight scalars for the input grid points varies in time. |
RemarksThis method only works with static grids. For grids that use geometric values for the statistical weight this value could be area or volume covered, for example.
See Also