HeatScatter

Creates a heat map representing the density of a 2-d probability distribution. This is useful when you want to visualize a joint probability distribution but the sample size is so large that a scatter plot would have an overwhelming number of points.

class HeatScatter : HeatMap {

static HeatScatter opCall(R1 x, R2 y, uint nRows, uint nCols);

static HeatScatter opCall(R1 x, R2 y, uint nRows, uint nCols, double xMin, double xMax, double yMin, double yMax, OutOfBounds boundsBehavior);

static HeatScatter opCall(I nRows, uint nCols, double xMin, double xMax, double yMin, double yMax, OutOfBounds boundsBehavior);

This put(double x, double y);

This put(HeatScatter rhs);

void boundsBehavior(OutOfBounds behavior);

}

Members

Functions

boundsBehavior void boundsBehavior(OutOfBounds behavior): Determine whether this object throws or ignores if it receives a number outside its bounds via put.
put This put(double x, double y): Add an element to the plot.
put This put(HeatScatter rhs): Add another HeatScatter's data to this. The boundaries and row and column counts must be the same. The settings from this HeatScatter are preserved.

Static functions

opCall HeatScatter opCall(R1 x, R2 y, uint nRows, uint nCols): Create a HeatScatter. x, y must be forward ranges with elements implicitly convertible to double, and must have the same lengths.
opCall HeatScatter opCall(R1 x, R2 y, uint nRows, uint nCols, double xMin, double xMax, double yMin, double yMax, OutOfBounds boundsBehavior): Create a HeatScatter with pre-specified bounds. x, y must be forward ranges with elements implicitly convertible to double, and must have the same lengths.
opCall HeatScatter opCall(I nRows, uint nCols, double xMin, double xMax, double yMin, double yMax, OutOfBounds boundsBehavior): Create a blank HeatScatter to fill in using the put() method.

Inherited Members

From HeatMap

deprecatedMsg enum string deprecatedMsg;: Undocumented in source.
heatMapDefaultBounds void heatMapDefaultBounds(): Undocumented in source. Be warned that the author may not have intended to support it.
setMinMax void setMinMax(): Undocumented in source. Be warned that the author may not have intended to support it.
drawLegendSymbol void drawLegendSymbol(FigureBase fig, PlotRect where): Undocumented in source. Be warned that the author may not have intended to support it.
enforceRectangular void enforceRectangular(): Undocumented in source. Be warned that the author may not have intended to support it.
drawPlot void drawPlot(Figure form, double leftMargin, double topMargin, double plotWidth, double plotHeight): Undocumented in source. Be warned that the author may not have intended to support it.
hasLegend bool hasLegend(): Undocumented in source. Be warned that the author may not have intended to support it.
coldColor Color coldColor(): Undocumented in source. Be warned that the author may not have intended to support it.
coldColor This coldColor(Color newColor): Undocumented in source. Be warned that the author may not have intended to support it.
hotColor Color hotColor(): Undocumented in source. Be warned that the author may not have intended to support it.
hotColor This hotColor(Color newColor): Undocumented in source. Be warned that the author may not have intended to support it.
colors Color[] colors()
colors This colors(Color[] newColors): Set the colors to be used for this HeatMap as an array from coldest (smallest value) to warmest (largest value). newColors.length must be >= 2.
opCall HeatMap opCall(R data): Create a heat map from a matrix represented as a range of ranges. The matrix must be rectangular. The elements of the ranges must be implicitly convertible to double.
noCopy HeatMap noCopy(double[][] mat): Create a heat map w/o copying data.
nRows uint nRows()
nCols uint nCols()
legendText This legendText(string ignored): Throws an exception. Heat maps aren't allowed to have legends.