Command: ChnStatisticsBlockCalc

Download PDF

Updated2024-09-12
4 minute(s) read

Calculates characteristic statistical values rowwise.

Set ChnResult = ChnStatisticsBlockCalc(ChnList1, StatsSelection, [StatsStartIndex], [StatsEndIndex], [StatsUsePopulationFormula], [StatsResultChn], [StatsResultChnNames], [StatsResultChnNameFormat])

Input Parameters

ChnList1

Specifies one or more channels.

StatsSelection

Specifies which statistical characteristic values to calculate.

Longinteger

0 <= StatsSelection <= 2147483647
Access: Read/Write

The StatsSelection variable can accept the following constants, which you use for calculating several characteristic values with the OR operator:

2^0	eStatsIndex	Index number
2^1	eStatsSum	Sum
2^2	eStatsSumOfSquares	Square sum
2^3	eStatsMinimum	Minimum
2^4	eStatsMaximum	Maximum
2^5	eStatsArithmeticMean	Arithmetic mean
2^6	eStatsSquareMean	Root mean square
2^7	eStatsGeometricMean	Geometric mean
2^8	eStatsHarmonicMean	Harmonic mean
2^9	eStatsLowerQuartile	0.25 quantile (lower quartile)
2^10	eStatsMedian	0.50 quantile (median)
2^11	eStatsUpperQuartile	0.75 quantile (upper quartile)
2^12	eStatsRange	Range
2^13	eStatsStandardDeviation	Standard deviation
2^14	eStatsVariance	Variance
2^15	eStatsVariationCoefficient	Variation coefficient
2^16	eStatsQuartileDistance	Quartile distance
2^17	eStatsRelativeVariationCoefficient	Relative variation coefficient
2^18	eStatsAverageAbsoluteDeviationFromMean	Average absolute deviation from mean
2^19	eStatsAverageAbsoluteDeviationFromMedian	Average absolute deviation from median
2^20	eStatsSkewness	Skewness
2^21	eStatsKurtosis	Kurtosis
2^22	eStatsStandardError	Standard error
2^23	eStatsExcessKurtosis	Excess
2^24	eStatsThreeSigma	Three sigma
2^25	eStatsSixSigma	Six sigma
2^26	eStatsNormDistB	Anderson-Darling test
2^27	eStats0025Quantile	0.025 quantile
2^28	eStats0975Quantile	0.975 quantile
(2^31)-1	eStatsAll	All values

In addition, you can use the following constants which contain the associated characteristic values: eStatsGroupAverageAbsDeviation, eStatsGroupDispersion, eStatsGroupExtremeValues, eStatsGroupForm, eStatsGroupMeanValues, eStatsGroupQuantiles, and eStatsGroupSums.

[StatsStartIndex]

Specifies the start row of the channel to be evaluated. The default value is NoValue which means that DIAdem starts from the first row.

[StatsEndIndex]

Specifies the end row of the channel to be evaluated. The default value is NoValue, which specifies that DIAdem uses the channel length.

[StatsUsePopulationFormula]

Specifies whether DIAdem calculates the characteristic values based on the population or on the sample. If the value is False, DIAdem calculates the characteristic values based on samples. The default value is False.

[StatsResultChn]

Specifies whether DIAdem stores the statistics results in data channels. The default value is False.

[StatsResultChnNames]

Specifies whether DIAdem stores the input channel names of the descriptive statistics in a text channel. The default value is False.

[StatsResultChnNameFormat]

Specifies how DIAdem stores the input channel names of the descriptive statistics in a text channel. The default value is False.

Return Parameters

ChnResult

Contains the result channel or the result channels with the characteristic values. ElementList <Data> type return value.

Refer to the help page Statistical Characteristic Values in DIAdem for mathematical details.

The following example calculates the statistical parameters minimum, maximum, and arithmetic mean for the channels of the fourth channel group starting with temperature and outputs the name of the first result channel and its first value.

VBScript

Python

Copy script

Dim MyChannels 
Set MyChannels = Data.GetChannels("[4]/Temperature*")
Set ChnResult = ChnStatisticsBlockCalc(MyChannels, eStatsMinimum + eStatsMaximum + eStatsArithmeticMean,,,,True)
Call Msgbox(ChnResult.Item(1).Name & ": " & ChnResult.Item(1).Values(1))

MyChannels = dd.Data.GetChannels("[4]/Temperature*") 
dd.ChnResult = dd.ChnStatisticsBlockCalc(MyChannels, eStatsMinimum + eStatsMaximum + eStatsArithmeticMean,"" ,"" ,"" ,True) 
print(dd.ChnResult.Item(1).Name + ": " + dd.ChnResult.Item(1).Values(1))

Dialog Box Call

Call SUDDlgShow("Main", ResourceDrv & "AnaChnStatisticsChannel_BlockCalc")

Descriptive statistics

DIAdem Help

Table of Contents

Command: ChnStatisticsBlockCalc

Input Parameters

Return Parameters

Dialog Box Call