com.esri.arcgis.system
Interface IFrequencyStatistics

All Superinterfaces:
Serializable
All Known Implementing Classes:
BaseStatistics

public interface IFrequencyStatistics
extends Serializable

Provides access to members used for reporting frequency statistics.

Description

IFrequencyStatistics is used to return information about your data values that is similar to an equal-interval histogram. You can use ComputeAutoFrequencyIntervals to let the system choose a suitable data interval, or set it manually with the FrequencyIntervalCount property. Retrieve the frequency values with FrequencyClassCount, which uses a zero-based index.

You can QI to IFrequencyStatistics after calling IDataStatistics::Statistics as long as IDataStatistics::SimpleStats is False.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void computeAutoFrequencyIntervals()
          Computes a suitable frequency interval count for the number of values.
 int getFrequencyClassCount(int intervalIndex)
          The frequency class count at a given interval index.
 int getFrequencyIntervalCount()
          The frequency interval count.
 double getFrequencyIntervalSize()
          The size (range) of each frequency interval.
 void setFrequencyIntervalCount(int numIntervals)
          The frequency interval count.
 

Method Detail

getFrequencyIntervalCount

int getFrequencyIntervalCount()
                              throws IOException,
                                     AutomationException
The frequency interval count.

Description

Either set the number of data intervals using the FrequencyIntervalCount property or use the ComputeAutoFrequencyIntervals method to automatically set the FrequencyIntervalCount based upon the data in the BaseStatistics.

Use the FrequencyIntervalSize to return the size range of each data interval.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The numIntervals
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFrequencyIntervalCount

void setFrequencyIntervalCount(int numIntervals)
                               throws IOException,
                                      AutomationException
The frequency interval count.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
numIntervals - The numIntervals (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

computeAutoFrequencyIntervals

void computeAutoFrequencyIntervals()
                                   throws IOException,
                                          AutomationException
Computes a suitable frequency interval count for the number of values.

Description

The ComputeAutoFrequencyIntervals automatically sets the FrequencyIntervalCount based upon the data in the BaseStatistics.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFrequencyIntervalSize

double getFrequencyIntervalSize()
                                throws IOException,
                                       AutomationException
The size (range) of each frequency interval.

Description

Returns the size range of each data interval based upon the FrequencyIntervalCount property and the data values in the BaseStatistics.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The intervalSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFrequencyClassCount

int getFrequencyClassCount(int intervalIndex)
                           throws IOException,
                                  AutomationException
The frequency class count at a given interval index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
intervalIndex - The intervalIndex (in)
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.