AFAggregate.Histogram(T, TBin) Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Generates a histogram for the specified items with the specified weighting.
Namespace: OSIsoft.AF.Data.Aggregate
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public static AFBinnedResult<TBin> Histogram<T, TBin>( this IEnumerable<T> items, string field, IEnumerable<TBin> bins, UOM binUOM ) where T : AFObject where TBin : Object, IComparable<TBin>
<ExtensionAttribute> Public Shared Function Histogram(Of T As AFObject, TBin As {Object, IComparable(Of TBin)}) ( items As IEnumerable(Of T), field As String, bins As IEnumerable(Of TBin), binUOM As UOM ) As AFBinnedResult(Of TBin) Dim items As IEnumerable(Of T) Dim field As String Dim bins As IEnumerable(Of TBin) Dim binUOM As UOM Dim returnValue As AFBinnedResult(Of TBin) returnValue = items.Histogram(field, bins, binUOM)
public: [ExtensionAttribute] generic<typename T, typename TBin> where T : AFObject where TBin : Object, IComparable<TBin> static AFBinnedResult<TBin>^ Histogram( IEnumerable<T>^ items, String^ field, IEnumerable<TBin>^ bins, UOM^ binUOM )
[<ExtensionAttribute>] static member Histogram : items : IEnumerable<'T> * field : string * bins : IEnumerable<'TBin> * binUOM : UOM -> AFBinnedResult<'TBin> when 'T : AFObject when 'TBin : Object and IComparable<'TBin>
Parameters
- items
- Type: System.Collections.GenericIEnumerableT
The items that should be summarized. - field
- Type: SystemString
The field whose value should be binned. - bins
- Type: System.Collections.GenericIEnumerableTBin
The bins the field should be sorted into. - binUOM
- Type: OSIsoft.AF.UnitsOfMeasureUOM
The unit of measure associated with bin values.
Type Parameters
- T
- The type of items to summarize
- TBin
- The type of the histogram bins.
Return Value
Type: AFBinnedResultTBinA result containing the requested histogram or an error if the summaries could not be performed.