oevislib_net.Histogram Class Reference

Represents the distribution of a numeric variable's values. More...

Inheritance diagram for oevislib_net.Histogram:

Public Member Functions
	Histogram ()
	Constructs an empty Histogram object with bin size set to 1.0f, starting (and ending) the domain at 0.0f.
	Histogram (float inDomainStart, float inDomainEnd, float inBinSize)
	Constructs a new Histogram object, given start and end values for the domain and the bins' width.
	Histogram (float inDomainStart, float inBinSize, int inBinCount, double inValue=0)
	Constructs a new Histogram object, given the domain and the number of bins.
	Histogram (float inDomainStart, float inBinSize, double[] inData, int inBinCount)
	Constructs a new Histogram object from existing data.
	Histogram (Array< double > inValues, int inStartIndex=0, float inDomainStart=0.0f, float inBinSize=1.0f, Optional< int > inBinCount=null)
	Constructs a new Histogram from an existing distribution.
	Histogram (Array< float > inValues, Optional< Array< double > > inWeights=null, Optional< float > inDomainStart=null, float inBinSize=1.0f, Optional< int > inBinCount=null, bool inCyclic=false)
	Creates a new Histogram object given an array of values and their relative weights.
Histogram	Copy ()
float	GetDomainStart ()
	Returns the domain starting value.
float	GetBinSize ()
	Returns the bin size.
int	GetBinCount ()
	Returns the number of bins.
float	GetDomainLength ()
	Returns the domain length.
float	GetDomainEnd ()
	Returns the domain end.
int	GetSize ()
	Returns the number of histogram bins.
void	SetDomainStart (float inDomainStart)
	Sets the domain starting value.
void	SetDomainStartOf (Histogram inHistogram)
	Sets the domain start value from another Histogram starting value.
void	SetBinSize (float inBinSize)
	Sets a new bin size.
void	SetBinSizeOf (Histogram inHistogram)
	Sets the same bin size as another Histogram.
void	SetBinCount (int inBinCount)
	Sets a new number of bins.
void	SetBinCountOf (Histogram inHistogram)
	Sets the same bin count of another Histogram.
double[]	GetData ()
	Returns the pointer to the array's values.
bool	HasSameDomain (Histogram inHistogram)
	Checks if two histograms have the same domain.
ByteBuffer	Serialize ()
	Serialize the Histogram object using flatbuffers.
float	GetBinStart (int inIndex, bool inCyclic=false, bool inInverse=false, Optional< double > outValue=null)
	Returns the lower bound of a specific histogram bar.
float	GetBinEnd (int inIndex, bool inCyclic=false, bool inInverse=false, Optional< double > outValue=null)
	Returns the upper bound of a specific histogram bar.
void	SetBin (int inIndex, double inValue, bool inCyclic, bool inInverse)
	Sets the value of a specific bin.
double	GetBinValue (float inBin, bool inCyclic)
	Returns the value of the bin of which inBin is part.
void	SetBinValue (float inBin, double inValue, bool inCyclic)
	Sets the value of the bin of which inBinValue is part.
Array< int >	GetIndices ()
	Returns the array of indices for the histogram (increasing values starting from 0).
float	GetDataAverage ()
	Computes the average value in the histogram's domain.
float	GetDataVariance ()
	Computes the variance of the histogram's domain.
float	GetDataStdDev ()
	Computes the standard deviation of the histogram's domain.
float	GetDataMinValue ()
	Computes the smallest of (non-empty) bin value.
float	GetDataMaxValue ()
	Computes the largest of (non-empty) bin values.
double	GetDataSize ()
	Computes the sum of all values contained in the bins.
float	GetDataNthValue (double inN, SortingOrder inSortingOrder)
	Computes the nth smallest (or largest) value in the domain.
float	GetDataMedian ()
	Computes the median in the histogram's domain.
float	GetDataQuantile (float inQuantile)
	Computes the specified quantile in the histogram's domain.
double	GetAverage ()
	Computes the average of the histogram's frequencies.
double	GetMaximum (Optional< Range > inRange=null, InterpolationMethod1D inInterpolationMethod=InterpolationMethod1D.Precise, Optional< int > outIndex=null, Optional< float > outPoint=null)
	Computes the higher histogram's frequency.
double	GetMinimum (Optional< Range > inRange=null, InterpolationMethod1D inInterpolationMethod=InterpolationMethod1D.Precise, Optional< int > outIndex=null, Optional< float > outPoint=null)
	Computes the lowest histogram's frequency.
double	GetSum ()
	Computes the sum of the histogram's frequencies.
Array< HistogramExtremum >	GetLocalExtrema (bool inConsiderPlateaus, ExtremumType inExtremumType, Optional< Range > inRange=null, Optional< double > inMinValue=null, Optional< double > inMaxValue=null, bool inCyclic=false, InterpolationMethod1D inInterpolationMethod=InterpolationMethod1D.Precise, Optional< LocalBlindness > inLocalBlindness=null)
	Computes the histogram local extrema.
Histogram	GaussianSmooth (Optional< Range > inRange=null, float inStdDev=0.6f, float inKernelRelativeSize=3.0f, bool inCyclic=false)
	Smooths the histogram by averaging points inside a kernel using Gaussian-weighted average.
Histogram	Smooth (Optional< Range > inRange=null, int inKernelRadius=3, bool inCyclic=false)
	Smooths the histogram by averaging points inside a kernel.
Histogram	ConvertToCumulativeHistogram ()
	Computes the cumulative histogram from the current one.
bool	Dominates (Histogram inHistogram)
	Checks if every value in the current histogram is greater or equal to the corresponding value in the input histogram.
bool	Equals (Histogram other)
override bool	Equals (object obj)
override int	GetHashCode ()
override object	Clone ()
override void	Dispose ()

Static Public Member Functions
static bool	operator== (Histogram inHistogram1, Histogram inHistogram2)
static bool	operator!= (Histogram inHistogram1, Histogram inHistogram2)
static Histogram	Deserialize (ByteBuffer inBuffer)
	De-serialize a Histogram buffer.

Properties
double	this[int i] [get, set]

Detailed Description

Represents the distribution of a numeric variable's values.

It is made by: an array of numeric values (representing the frequency in every bin); the domain start that represents the lowest value for which frequency is measured; the bin size that determines the width of every histogram's bin.