GetThemeStatistics()

Summary

Gets statistical information about a color or pattern theme.

Syntax

stats = GetThemeStatistics(string theme_name, integer sample_size)

Argument Contents
theme_name The name of the theme
sample_size Currently ignored

Returns

An array of two elements.

Statistics element Type Contents
1 Array Aggregate theme statistics
2 Array An array of statistics for each class, starting with the Other class (if it exists) followed by the remaining classes
Theme Statistics Type Contents
1 Integer Number of features
2 Integer Number of features used
3 Integer Number of missing features
4 Integer Number of features below the minimum value
5 Integer Number of features above the maximum value
6 Real Sum of the data values
7 Real Minimum data value
8 Real Maximum data value
9 Real Mean of the data values
10 Real Variance of the data values
11 Real Standard deviation of the data values
12 Real Skewness of the data values
13 Real Kurtosis of the data values
14 Real Median data value
15 Real Goodness of variance fit (GVF) of the data values
16 Real Goodness of absolute deviation fit (GADF) of the data values
17 Real F of the data values
Class Statistics Type Contents
1 Integer Number of features in the class
2 Real Sum of the data values in the class
3 Real Minimum data value in the class
4 Real Maximum data value in the class
5 Real Mean of the data values in the class
6 Real Variance of the data values in the class
7 Real Standard deviation of the data values in the class
8 Real Median data value in the class
9 Real Percent of the data values contained by the class

Error Codes

Error Meaning
Escape The user interrupted scanning of the data
Error An error occurred while scanning the data
NotFound The specified theme does not exist

See Also

Function Summary
CreateTheme() Creates a color or pattern theme on the current layer
GetThemeClasses() Gets information about the classes of a color or pattern theme
GetThemeOptions() Gets a list of options for a theme
TestTheme() Provides information on the classes created by a call toCreateTheme()