Command: ChnStatisticsChannelCalc

Display all  Hide all

Command: ChnStatisticsChannelCalc

Calculates characteristic statistical values channelwise.

Input Parameters

ChnList1	Specifies one or more channels. Channel list variable A channel list is a Channel or Channel list object, or a text that refers to one or several channels. For more information about the value range, refer to Channel lists.
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. Longinteger 1 <= StatsStartIndex <= 2147483647 Access: Read/Write
[StatsEndIndex]	Specifies the end row of the channel to be evaluated. The default value is NoValue, which specifies that DIAdem uses the channel length. Longinteger 1 <= StatsEndIndex <= 2147483647 Access: Read/Write
[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. Boolean Access: Read/Write
[StatsResultChn]	Specifies whether DIAdem stores the statistics results in data channels. The default value is False. Boolean Access: Read/Write
[StatsResultChnNames]	Specifies whether DIAdem stores the input channel names of the descriptive statistics in a text channel. The default value is False. Boolean Access: Read/Write
[StatsResultChnNameFormat]	Specifies how DIAdem stores the input channel names of the descriptive statistics in a text channel. The default value is False. Enumeration variable Enumeration variable with the following selection terms Script Term Interface Term, Explanation "NameName" Group name/Channel name "IndexName" [Group index]/Channel name "NameIndex" Group name/[Channel index] "IndexIndex" [Group index]/[Channel index] "OnlyName" Only channel name

Return Parameters

If you execute the evaluation over all rows of the selected channels, DIAdem saves the results in the following custom properties of the input channel: Result~Statistics~AverageAbsDeviation~FromMean, Result~Statistics~AverageAbsDeviation~FromMedian, Result~Statistics~Dispersion~QuartileDistance, Result~Statistics~Dispersion~Range, Result~Statistics~Dispersion~RelativeVariationCoefficient, Result~Statistics~Dispersion~StandardDeviation, Result~Statistics~Dispersion~StandardError, Result~Statistics~Dispersion~Variance, Result~Statistics~Dispersion~VariationCoefficient, Result~Statistics~ExtremeValues~Maximum, Result~Statistics~ExtremeValues~Minimum, Result~Statistics~Form~ExcessKurtosis, Result~Statistics~Form~Kurtosis, Result~Statistics~Form~Skewness, Result~Statistics~MeanValues~ArithmeticMean, Result~Statistics~MeanValues~GeometricMean, Result~Statistics~MeanValues~HarmonicMean, Result~Statistics~MeanValues~SquareMean, Result~Statistics~Quantiles~LowerQuartile, Result~Statistics~Quantiles~Median, Result~Statistics~Quantiles~UpperQuartile, Result~Statistics~Sums~Sum, Result~Statistics~Sums~SumOfSquares, Result~Statistics~Dispersion~ThreeSigma, and Result~Statistics~Dispersion~SixSigma. For the Anderson-Darling test, DIAdem saves the results also in the following custom properties of the input channel: Result~Statistics~NormalDistribution~AndersonDarling~IsNormalDistributed and Result~Statistics~NormalDistribution~AndersonDarling~p.
If you execute evaluation only on specific lines of the selected channels, DIAdem does not store the results in custom properties because the assignment to the input channel is not unique.

In addition, DIAdem stores the names and values of the custom properties in the StatsPropertyName and StatsResult variables after the calculation.

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

The following example calculates the statistical characteristic values minimum, maximum, and geometric mean for the first channel of the first channel group and displays the values. DIAdem saves the results as custom properties of the input channel.

Set ChnResult = ChnStatisticsChannelCalc("[1]/[1]", eStatsMinimum + eStatsMaximum + eStatsGeometricMean)
Call MsgBox(StatsPropertyName(eStatsMinimum) & " : " & StatsResult(eStatsMinimum) & VBCrLf & _
            StatsPropertyName(eStatsMaximum) & " : " & StatsResult(eStatsMaximum) & VBCrLf & _
            StatsPropertyName(eStatsGeometricMean) & " : " & StatsResult(eStatsGeometricMean))

dd.ChnResult = dd.ChnStatisticsChannelCalc("[1]/[1]", eStatsMinimum + eStatsMaximum + eStatsGeometricMean) 
print(dd.StatsPropertyName(eStatsMinimum) + " : " + dd.StatsResult(eStatsMinimum) + "\r\n" + dd.StatsPropertyName(eStatsMaximum) + " : " + dd.StatsResult(eStatsMaximum) + "\r\n" + dd.StatsPropertyName(eStatsGeometricMean) + " : " + dd.StatsResult(eStatsGeometricMean)) 

Dialog Box Call

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

Descriptive statistics