Sage Modeling and Simulation Library

Histogram1D_Base Members

The Histogram1D_Base type exposes the following members.

Constructors


  Name Description
Public method Histogram1D_Base
Creates a 1D histogram.

Methods


  Name Description
Public method BiggestBin(HistogramBinCategory)
Returns the index of the bin that contains the most entries, selected from a specified set of bins.
Public method BiggestBin(array<Int32>[]()[][], array<Int32>[]()[][])
Returns the index of the bin that contains the most entries, selected from the bins between the requested low and high index bins.
Public method Clear
Clears this Histogram.
Public method CountEntries(HistogramBinCategory)
Counts the number of entries in a given range (low bin, in-band bins or high bin.)
Public method CountEntries(array<Int32>[]()[][], array<Int32>[]()[][])
Counts the number of entries in a given range of bins.
Public method DefaultLabelProvider
Provides the default label provider for the specified coordinates.
Public method Equals(System.Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method Error
This returns a value that indicates how far a specified bin's count deviates from the 'expected' count - note that it is only relevant if the histogram was expected to have been uniform.
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method GetLabel
Gets the label for the bin at the specified coordiantes.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method Recalculate()()()()
Recalculates this Histogram, resulting in new bins and counts.
Public method Recalculate(Array, Array, Int32)
Recalculates the Histogram with new high & low bounds, resulting in new bins and counts.
Public method SmallestBin(HistogramBinCategory)
Returns the index of the bin that contains the most entries, selected from a specified set of bins.
Public method SmallestBin(array<Int32>[]()[][], array<Int32>[]()[][])
Returns the index of the bin that contains the fewest entries, selected from the bins between the requested low and high index bins.
Public method SumEntries(HistogramBinCategory)
Returns the sum of values in all of the bins identified by the given HistogramBinCategory.
Public method SumEntries(array<Int32>[]()[][], array<Int32>[]()[][])
Returns the sum of values in all of the bins identified by the given low and high bounds.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)

Fields


  Name Description
Protected field HighBin
The count of data points whose values were greater than the high bound.
Protected field LowBin
The count of data points whose values were less than the low bound.
Protected field m_bins
The bins that contain the count of points in each bin.
Protected field m_highBound
The value of the high boundary. All data points that are greater than this value are tallied into the m_highBin bin.
Protected field m_lowBound
The value of the low boundary. All data points that are less than this value are tallied into the m_lowBin bin.
Protected field m_rawData
The raw data array that provides the underlying histogram data.
Protected field NumBins
The number of bins in this Histogram.

Properties


  Name Description
Public property Bins
Gets the bins that are a part of this Histogram.
Public property Description
A description of this Histogram1D_Base.
Public property Dimension
Gets the number of dimensions in this Histogram (a linear histogram is 1-dimensional).
Public property Guid
The Guid for this object. Typically required to be unique.
Public property HighBound
The data that represents the high bound of the in-band range.
Public property LabelProvider
Gets and sets the object that provides the name of a specified bin.
Public property LowBound
The data that represents the low bound of the in-band range.
Public property Name
The name for this object. Not typically required to be unique.
Public property RawData
Gets or sets the raw data that comprises this Histogram.