\(\renewcommand\AA{\unicode{x212B}}\)

StatisticsOfTableWorkspace v1¶

../_images/ImageNotFound.png — Enable screenshots using DOCS_SCREENSHOTS in CMake¶

Summary ¶

Calcuates columns statistics of a table workspace.

Properties ¶

Name	Direction	Type	Default	Description
InputWorkspace	Input	TableWorkspace	Mandatory	Input table workspace.
ColumnIndices	Input	long list		Comma separated list of column indices for which statistics will be separated
OutputWorkspace	Output	TableWorkspace	Mandatory	Output workspace containing column statistics.

Description ¶

Calculates mean, median, maximum, minimum and standard deviation for each numerical column of a table workspace.

Usage ¶

Example - Getting statistics of a table workspace.

ws = CreateEmptyTableWorkspace()
ws.addColumn('int', 'a')
ws.addColumn('float', 'b')
ws.addRow([1, 3.2])
ws.addRow([2, 3.4])
ws.addRow([3, 3.6])
ws.addRow([4, 3.8])

stats = StatisticsOfTableWorkspace(ws)

for idx in range(stats.rowCount()):
    stat_name = stats.column('Statistic')[idx]
    stat_value = stats.column('a')[idx]
    print('%s of column \'a\' is %.3f' % (stat_name, stat_value))

Output:

StandardDev of column 'a' is 1.118
Minimum of column 'a' is 1.000
Median of column 'a' is 2.500
Maximum of column 'a' is 4.000
Mean of column 'a' is 2.500

Categories: AlgorithmIndex | Utility\Workspaces