Click or drag to resize
Grid Solutions Framework

FilterOutliersTComputePhasorValue Class

Returns a series of values that represent the core data around the mean, excluding outliers, using Z-score. The confidence parameter, optional, is a floating-point value, suffixed with '%' representing a percentage, that must be greater than zero and less than one-hundred, that specifies the amount of data to retain around the mean, representing the central portion of the dataset - defaults to 95%. Second parameter, invertFilter, optional, is a boolean flag that determines if outliers should be rejected or retained - default is false, i.e., keep core data rejecting outliers; otherwise, true excludes core data and retains only outliers. Third parameter, minSamples, optional, is an integer value that specifies the minimum number of samples required for outlier detection - defaults to 20 for single series temporal analysis and 3 for multi-series slice analysis; if fewer samples are provided, the function returns the entire dataset unfiltered to ensure improved statistical validity of the Z-score calculations, or no data when invertFilter is true. If all values are considered identical, i.e., the standard deviation is zero, function will return the entire dataset unfiltered, or no data when invertFilter is true, since this represents a uniform distribution. The confidence parameter value can either be a constant value or a named target available from the expression. Any target values that fall between 0 and 1 will be treated as a percentage.
Inheritance Hierarchy
SystemObject
  GrafanaAdapters.FunctionsGrafanaFunctionBasePhasorValue
    GrafanaAdapters.Functions.BuiltInFilterOutliersPhasorValue
      GrafanaAdapters.Functions.BuiltInFilterOutliersTComputePhasorValue

Namespace: GrafanaAdapters.Functions.BuiltIn
Assembly: GrafanaAdapters (in GrafanaAdapters.dll) Version: 2.4.278-beta
Syntax
public class ComputePhasorValue : FilterOutliers<PhasorValue>
View Source

The FilterOutliersTComputePhasorValue type exposes the following members.

Constructors
 NameDescription
Public methodFilterOutliersTComputePhasorValueInitializes a new instance of the FilterOutliersTComputePhasorValue class
Top
Properties
 NameDescription
Public propertyAliases Gets any defined aliases for the Grafana function.
(Inherited from FilterOutliersT)
Public propertyAllowedGroupOperations Gets set of group operations that the Grafana function allows.
(Inherited from GrafanaFunctionBaseT)
Public propertyCategory Gets the category of the Grafana function, i.e., built-in or custom.
(Inherited from GrafanaFunctionBaseT)
Public propertyDataTypeIndex Gets the data source value type index associated with the Grafana function.
(Inherited from GrafanaFunctionBaseT)
Public propertyDescription Gets the description of the Grafana function.
(Inherited from FilterOutliersT)
Public propertyInternalParameterCount Gets the number of internal parameters of the Grafana function.
(Inherited from GrafanaFunctionBaseT)
Public propertyIsSliceSeriesEquivalent Gets or sets a flag indicating whether the function behaves equivalently when processed as a series or as a slice. Value defaults to true for functions that return a series of values, i.e., the return type is Series, and the AllowedGroupOperations includes the flag for Slice operations; otherwise, value defaults to false when the return type is a scalar value, i.e., Scalar, or the AllowedGroupOperations does not include the flag for Slice operations.
(Inherited from FilterOutliersT)
Public propertyName Gets the name of the Grafana function.
(Inherited from FilterOutliersT)
Public propertyOptionalParameterCount Gets the number of optional parameters of the Grafana function.
(Inherited from GrafanaFunctionBaseT)
Public propertyParameterDefinitions Gets the list of defined parameter definitions for the Grafana function.
(Inherited from FilterOutliersT)
Public propertyPublishedGroupOperations Gets set of group operations that the Grafana function exposes publicly.
(Inherited from GrafanaFunctionBaseT)
Public propertyRequiredParameterCount Gets the number of required parameters, not including data source values expression, of the Grafana function.
(Inherited from GrafanaFunctionBaseT)
Public propertyResultIsSetTargetSeries Gets flag that determines if function result is target series for set-based group operations.
(Inherited from GrafanaFunctionBaseT)
Public propertyReturnType Gets the return type of the Grafana function, i.e., scalar or series.
(Inherited from FilterOutliersT)
Top
Methods
 NameDescription
Public methodCheckAllowedGroupOperation Checks if function allows requested group operation against AllowedGroupOperations property.
(Inherited from GrafanaFunctionBaseT)
Public methodComputeAsync Executes the computation for the Grafana function.
(Inherited from FilterOutliersT)
Public methodComputeSetAsync Executes a custom set computation for the Grafana function.
(Inherited from GrafanaFunctionBaseT)
Public methodComputeSliceAsync Executes a custom slice computation for the Grafana function.
(Inherited from FilterOutliersT)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodExecuteFunction Executes specified function against data source values enumeration using provided parameters.
(Inherited from GrafanaFunctionBaseT)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFormatTargetName Gets a formatted target name for the Grafana function.
(Inherited from GrafanaFunctionBaseT)
Protected methodGetDataSourceValues Gets data source values enumeration found in the provided parameters.
(Inherited from GrafanaFunctionBaseT)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodParseParameters Executes custom parameter parsing for the Grafana function.
(Inherited from GrafanaFunctionBaseT)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Remarks
Signature: FilterOutliers([confidence = 95%], [invertFilter = false], [minSamples = 20 or 3 for slice], expression)
Returns: Series of values.
Example 1: FilterOutliers(85%, BROWNS_FERRY:FREQ)
Example 2: SliceFilterOutliers(0.033, FILTER ActiveMeasurements WHERE SignalType='FREQ')
Variants: FilterOutliers, ZScoreFilter, GaussianFilter
Execution: Immediate in-memory array load.
Group Operations: Slice, Set
See Also