C# Class Accord.Statistics.Visualizations.Histogram

Inheritance: ICloneable
显示文件 Open project: accord-net/framework Class Usage Examples

Public Methods

Method Description
Add ( Histogram histogram ) : Histogram

Adds one histogram from the other, storing results in a new histogram, without changing the current instance.

Add ( int histogram ) : Histogram

Adds one histogram from the other, storing results in a new histogram, without changing the current instance.

Clone ( ) : object

Creates a new object that is a copy of the current instance.

Compute ( double values ) : void

Computes (populates) an Histogram mapping with values from a sample.

Compute ( double values, double binWidth ) : void

Computes (populates) an Histogram mapping with values from a sample.

Compute ( double values, int numberOfBins ) : void

Computes (populates) an Histogram mapping with values from a sample.

Compute ( double values, int numberOfBins, bool extraUpperBin ) : void

Computes (populates) an Histogram mapping with values from a sample.

Compute ( double values, int numberOfBins, double binWidth ) : void

Computes (populates) an Histogram mapping with values from a sample.

FromData ( double values ) : Histogram

Creates a histogram of values from a sample.

GetRange ( double percent ) : IntRange

Get range around median containing specified percentage of values.

The method calculates range of stochastic variable, which summary probability comprises the specified percentage of histogram's hits.

Sample usage:

// create histogram Histogram histogram = new Histogram( new int[10] { 0, 0, 1, 3, 6, 8, 11, 0, 0, 0 } ); // get 50% range IntRange range = histogram.GetRange( 0.5 ); // show the range ([4, 6]) Console.WriteLine( "50% range = [" + range.Min + ", " + range.Max + "]" );
Histogram ( ) : System

Constructs an empty histogram

Histogram ( int values ) : System

Constructs an empty histogram

Multiply ( int histogram ) : Histogram

Multiplies one histogram from the other, storing results in a new histogram, without changing the current instance.

NumberOfBins ( double values, DoubleRange range, BinAdjustmentRule rule ) : int

Computes the optimum number of bins based on a BinAdjustmentRule.

Subtract ( Histogram histogram ) : Histogram

Subtracts one histogram from the other, storing results in a new histogram, without changing the current instance.

Subtract ( int histogram ) : Histogram

Subtracts one histogram from the other, storing results in a new histogram, without changing the current instance.

ToArray ( ) : int[]

Converts this histogram into an integer array representation.

Update ( ) : void

Update statistical value of the histogram.

The method recalculates statistical values of the histogram, like mean, standard deviation, etc., in the case if histogram's values were changed directly. The method should be called only in the case if histogram's values were retrieved through Values property and updated after that.

this ( int index ) : int

Gets the Bin values of this Histogram.

Private Methods

Method Description
Histogram ( double values ) : System
compute ( double values ) : void

Actually computes the histogram.

initialize ( double startValue, double width ) : void

Sets the histogram's bin ranges (edges).

initialize ( int numberOfBins ) : void

Initializes the histogram's bins.

Method Details

Add() public method

Adds one histogram from the other, storing results in a new histogram, without changing the current instance.
public Add ( Histogram histogram ) : Histogram
histogram Histogram The histogram whose bin values will be added.
return Histogram

Add() public method

Adds one histogram from the other, storing results in a new histogram, without changing the current instance.
public Add ( int histogram ) : Histogram
histogram int The histogram whose bin values will be added.
return Histogram

Clone() public method

Creates a new object that is a copy of the current instance.
public Clone ( ) : object
return object

Compute() public method

Computes (populates) an Histogram mapping with values from a sample.
public Compute ( double values ) : void
values double The values to be binned in the histogram.
return void

Compute() public method

Computes (populates) an Histogram mapping with values from a sample.
public Compute ( double values, double binWidth ) : void
values double The values to be binned in the histogram.
binWidth double The desired width for the histogram's bins.
return void

Compute() public method

Computes (populates) an Histogram mapping with values from a sample.
public Compute ( double values, int numberOfBins ) : void
values double The values to be binned in the histogram.
numberOfBins int The desired number of histogram's bins.
return void

Compute() public method

Computes (populates) an Histogram mapping with values from a sample.
public Compute ( double values, int numberOfBins, bool extraUpperBin ) : void
values double The values to be binned in the histogram.
numberOfBins int The desired number of histogram's bins.
extraUpperBin bool Whether to include an extra upper bin going to infinity.
return void

Compute() public method

Computes (populates) an Histogram mapping with values from a sample.
public Compute ( double values, int numberOfBins, double binWidth ) : void
values double The values to be binned in the histogram.
numberOfBins int The desired number of histogram's bins.
binWidth double The desired width for the histogram's bins.
return void

FromData() public method

Creates a histogram of values from a sample.
public FromData ( double values ) : Histogram
values double The values to be binned in the histogram.
return Histogram

GetRange() public method

Get range around median containing specified percentage of values.

The method calculates range of stochastic variable, which summary probability comprises the specified percentage of histogram's hits.

Sample usage:

// create histogram Histogram histogram = new Histogram( new int[10] { 0, 0, 1, 3, 6, 8, 11, 0, 0, 0 } ); // get 50% range IntRange range = histogram.GetRange( 0.5 ); // show the range ([4, 6]) Console.WriteLine( "50% range = [" + range.Min + ", " + range.Max + "]" );
public GetRange ( double percent ) : IntRange
percent double Values percentage around median.
return AForge.IntRange

Histogram() public method

Constructs an empty histogram
public Histogram ( ) : System
return System

Histogram() public method

Constructs an empty histogram
public Histogram ( int values ) : System
values int The values to be binned in the histogram.
return System

Multiply() public method

Multiplies one histogram from the other, storing results in a new histogram, without changing the current instance.
public Multiply ( int histogram ) : Histogram
histogram int The histogram whose bin values will be multiplied.
return Histogram

NumberOfBins() public static method

Computes the optimum number of bins based on a BinAdjustmentRule.
public static NumberOfBins ( double values, DoubleRange range, BinAdjustmentRule rule ) : int
values double
range AForge.DoubleRange
rule BinAdjustmentRule
return int

Subtract() public method

Subtracts one histogram from the other, storing results in a new histogram, without changing the current instance.
public Subtract ( Histogram histogram ) : Histogram
histogram Histogram The histogram whose bin values will be subtracted.
return Histogram

Subtract() public method

Subtracts one histogram from the other, storing results in a new histogram, without changing the current instance.
public Subtract ( int histogram ) : Histogram
histogram int The histogram whose bin values will be subtracted.
return Histogram

ToArray() public method

Converts this histogram into an integer array representation.
public ToArray ( ) : int[]
return int[]

Update() public method

Update statistical value of the histogram.
The method recalculates statistical values of the histogram, like mean, standard deviation, etc., in the case if histogram's values were changed directly. The method should be called only in the case if histogram's values were retrieved through Values property and updated after that.
public Update ( ) : void
return void

this() public method

Gets the Bin values of this Histogram.
public this ( int index ) : int
index int Bin index.
return int