Histogram Class

Histogram.

Inheritance Hierarchy

SystemObject
Accord.Statistics.VisualizationsHistogram

Namespace: Accord.Statistics.Visualizations
Assembly: Accord.Statistics (in Accord.Statistics.dll) Version: 3.8.0

Syntax

Copy

[SerializableAttribute]
public class Histogram : ICloneable

<SerializableAttribute>
Public Class Histogram
	Implements ICloneable

Request Example View Source

The Histogram type exposes the following members.

Constructors

	Name	Description
	Histogram	Constructs an empty histogram
	Histogram(Double)	Obsolete. Constructs an empty histogram
	Histogram(Int32)	Constructs an empty histogram

Top

Properties

	Name	Description
	AutoAdjustmentRule	Gets or sets the bin size auto adjustment rule to be used when computing this histogram from new data. Default is SquareRoot.
	Bins	Gets the collection of bins of this Histogram.
	Cumulative	Gets or sets whether this histogram represents a cumulative distribution.
	Edges	Gets the edges of each bin in this Histogram.
	InclusiveUpperBound	Gets or sets a value indicating whether the last bin should have an inclusive upper bound. Default is true.
	Item	Gets the Bin values of this Histogram.
	Max	Maximum value.
	Mean	Mean value.
	Median	Median value.
	Min	Minimum value.
	Range	Gets the Range of the values in this Histogram.
	StdDev	Standard deviation.
	TotalCount	Total count of values.
	Values	Gets the Bin values for this Histogram.

Top

Methods

	Name	Description
	Add(Int32)	Adds a value to each histogram bin.
	Add(Int32)	Adds one histogram from the other, storing results in a new histogram, without changing the current instance.
	Add(Histogram)	Adds one histogram from the other, storing results in a new histogram, without changing the current instance.
	Clone	Creates a new object that is a copy of the current instance.
	Compute(Double)	Computes (populates) an Histogram mapping with values from a sample.
	Compute(Double, Double)	Computes (populates) an Histogram mapping with values from a sample.
	Compute(Double, Int32)	Computes (populates) an Histogram mapping with values from a sample.
	Compute(Double, Int32, Boolean)	Computes (populates) an Histogram mapping with values from a sample.
	Compute(Double, Int32, Double)	Computes (populates) an Histogram mapping with values from a sample.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FromData	Creates a histogram of values from a sample.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetRange	Get range around median containing specified percentage of values.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Multiply(Int32)	Multiplies one histogram from the other, storing results in a new histogram, without changing the current instance.
	Multiply(Int32)	Multiplies one histogram from the other, storing results in a new histogram, without changing the current instance.
	NumberOfBins	Computes the optimum number of bins based on a BinAdjustmentRule.
	Subtract(Int32)	Subtracts a value to each histogram bin.
	Subtract(Int32)	Subtracts one histogram from the other, storing results in a new histogram, without changing the current instance.
	Subtract(Histogram)	Subtracts one histogram from the other, storing results in a new histogram, without changing the current instance.
	ToArray	Converts this histogram into an integer array representation.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Update statistical value of the histogram.

Top

Operators

	Name	Description
	(Histogram to Int32)	Integer array implicit conversion.

Top

Extension Methods

	Name	Description
	HasMethod	Checks whether an object implements a method with the given name. (Defined by ExtensionMethods.)
	IsEqual	Compares two objects for equality, performing an elementwise comparison if the elements are vectors or matrices. (Defined by Matrix.)
	To(Type)	Overloaded. Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime. (Defined by ExtensionMethods.)
	ToT	Overloaded. Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime. (Defined by ExtensionMethods.)

Top

Remarks

In a more general mathematical sense, a histogram is a mapping Mi that counts the number of observations that fall into various disjoint categories (known as bins).

This class represents a Histogram mapping of Discrete or Continuous data. To use it as a discrete mapping, pass a bin size (length) of 1. To use it as a continuous mapping, pass any real number instead.

Currently, only a constant bin width is supported.

Reference

Accord.Statistics.Visualizations Namespace