A histogram that accumulates the number of values observed in a continuous range of user defined bins.
More...
|
void | Clear () |
|
void | Add (double value) |
|
void | AddRange (IEnumerable< double > values) |
|
double[] | GetProbability (double scale=1) |
| Return counts normalized so the sum of all values equals 1.
|
|
double[] | GetNormalized (double maxValue=1) |
| Return the probability of each bin scaled so the peak is maxValue
|
|
int[] | GetCumulativeCounts () |
| Return the cumulative sum of all counts. Each value is the number of counts in that bin plus all bins below it.
|
|
double[] | GetCumulativeProbability (double scale=1.0) |
| Return the cumulative probability histogram. Each value is the fraction of counts in that bin plus all bins below it.
|
|
|
static Histogram | WithBinSize (double binSize, double firstBin, double lastBin) |
| A collection of bins of size binSize where the first bin's left edge is firstBin and the last bin's left edge is lastBin
|
|
static Histogram | WithBinSize (double binSize, IEnumerable< double > values) |
| A collection of bins of size binSize starting from the smallest value in values and increasing to include the largest value in values
|
|
static Histogram | WithBinCount (int count, double minValue, double maxValue) |
| A collection of count evenly sized bins. minValue is the lower edge of the first bin. maxValue is the lower edge of the last bin.
|
|
static Histogram | WithBinCount (int count, IEnumerable< double > values) |
| A collection of count evenly sized bins spaced to include the full range of values
|
|
|
int[] | Counts [get] |
| Number of values in each bin.
|
|
double[] | Bins [get] |
| Lower edge of each bin.
|
|
double[] | Edges [get] |
| Lower edge of each bin plus a final value representing the upper edge of the last bin.
|
|
double | FirstBinSize [get] |
| Size of the first bin (distance between the first pair of bin edges)
|
|
bool | IncludeOutliers = false [get, set] |
| If enabled, values below or above the bin range will be accumulated in the lowest or highest bin.
|
|
A histogram that accumulates the number of values observed in a continuous range of user defined bins.
◆ Add()
void ScottPlot.Statistics.Histogram.Add |
( |
double |
value | ) |
|
|
inline |
◆ AddRange()
void ScottPlot.Statistics.Histogram.AddRange |
( |
IEnumerable< double > |
values | ) |
|
|
inline |
◆ Clear()
void ScottPlot.Statistics.Histogram.Clear |
( |
| ) |
|
|
inline |
◆ GetCumulativeCounts()
int[] ScottPlot.Statistics.Histogram.GetCumulativeCounts |
( |
| ) |
|
|
inline |
Return the cumulative sum of all counts. Each value is the number of counts in that bin plus all bins below it.
◆ GetCumulativeProbability()
double[] ScottPlot.Statistics.Histogram.GetCumulativeProbability |
( |
double |
scale = 1::0 | ) |
|
|
inline |
Return the cumulative probability histogram. Each value is the fraction of counts in that bin plus all bins below it.
◆ GetNormalized()
double[] ScottPlot.Statistics.Histogram.GetNormalized |
( |
double |
maxValue = 1 | ) |
|
|
inline |
Return the probability of each bin scaled so the peak is maxValue
◆ GetProbability()
double[] ScottPlot.Statistics.Histogram.GetProbability |
( |
double |
scale = 1 | ) |
|
|
inline |
Return counts normalized so the sum of all values equals 1.
◆ WithBinCount() [1/2]
static Histogram ScottPlot.Statistics.Histogram.WithBinCount |
( |
int |
count, |
|
|
double |
minValue, |
|
|
double |
maxValue |
|
) |
| |
|
inlinestatic |
A collection of count evenly sized bins. minValue is the lower edge of the first bin. maxValue is the lower edge of the last bin.
◆ WithBinCount() [2/2]
static Histogram ScottPlot.Statistics.Histogram.WithBinCount |
( |
int |
count, |
|
|
IEnumerable< double > |
values |
|
) |
| |
|
inlinestatic |
A collection of count evenly sized bins spaced to include the full range of values
◆ WithBinSize() [1/2]
static Histogram ScottPlot.Statistics.Histogram.WithBinSize |
( |
double |
binSize, |
|
|
double |
firstBin, |
|
|
double |
lastBin |
|
) |
| |
|
inlinestatic |
A collection of bins of size binSize where the first bin's left edge is firstBin and the last bin's left edge is lastBin
◆ WithBinSize() [2/2]
static Histogram ScottPlot.Statistics.Histogram.WithBinSize |
( |
double |
binSize, |
|
|
IEnumerable< double > |
values |
|
) |
| |
|
inlinestatic |
A collection of bins of size binSize starting from the smallest value in values and increasing to include the largest value in values
◆ Bins
double [] ScottPlot.Statistics.Histogram.Bins |
|
get |
◆ Counts
int [] ScottPlot.Statistics.Histogram.Counts |
|
get |
Number of values in each bin.
◆ Edges
double [] ScottPlot.Statistics.Histogram.Edges |
|
get |
Lower edge of each bin plus a final value representing the upper edge of the last bin.
◆ FirstBinSize
double ScottPlot.Statistics.Histogram.FirstBinSize |
|
get |
Size of the first bin (distance between the first pair of bin edges)
◆ IncludeOutliers
bool ScottPlot.Statistics.Histogram.IncludeOutliers = false |
|
getset |
If enabled, values below or above the bin range will be accumulated in the lowest or highest bin.
The documentation for this class was generated from the following file:
- ScottPlot/src/ScottPlot5/ScottPlot5/Statistics/Histogram.cs