Struct sampling::heatmap::HeatmapUsize

pub struct HeatmapUsize<HistWidth, HistHeight> { /* private fields */ }

Heatmap

• stores heatmap in row-major order: the rows of the heatmap are contiguous, and the columns are strided
• enables you to quickly create a heatmap
• you can create gnuplot scripts to plot the heatmap
• you can transpose the heatmap
• …

Implementations

impl<HistWidth, HistHeight> HeatmapUsize<HistWidth, HistHeight>

where HistWidth: Clone, HistHeight: Clone,

pub fn transpose(&self) -> HeatmapUsize<HistHeight, HistWidth>

Use this to get a “flipped” heatmap

• creates a transposed heatmap
• also look at self.transpose_inplace

impl<HistWidth, HistHeight> HeatmapUsize<HistWidth, HistHeight>

pub fn transpose_inplace(self) -> HeatmapUsize<HistHeight, HistWidth>

Use this to get a “flipped” heatmap

• transposes the heatmap inplace

pub fn get(&self, x: usize, y: usize) -> Option<usize>

Returns value stored in the heatmap at specified coordinates, or None, if out of Bounds

pub fn get_row(&self, y: usize) -> Option<&[usize]>

row of the heatmap

• None if out of bounds
• otherwise it is a slice of the row at height y

Note

• there is no get_column method, because, due to implementation details, it is way less efficient, and could not be returned as slice

pub unsafe fn get_unchecked(&self, x: usize, y: usize) -> usize

Returns value stored in the heatmap at specified coordinates without performing bound checks.

Safety

undefined behavior if coordinates are out of bounds

pub fn width(&self) -> usize

returns width of the heatmap

• the width is the same size, as the self.width_projection().bin_count()

pub fn height(&self) -> usize

returns height of the heatmap

• the height is the same size, as the self.height_projection().bin_count()

pub fn width_hist(&self) -> &HistWidth

Returns reference to current width Histogram

• histogram used to bin in the “width” direction
• all counts are counted here -> this is a projection of the heatmap

pub fn height_hist(&self) -> &HistHeight

Returns reference to current height Histogram

• histogram used to bin in the “height” direction
• all counts are counted here -> this is a projection of the heatmap

impl<HistWidth, HistHeight> HeatmapUsize<HistWidth, HistHeight>

where HistWidth: Histogram, HistHeight: Histogram,

pub fn new(width_hist: HistWidth, height_hist: HistHeight) -> Self

Create a new Heatmap

• heatmap will have width width_hist.bin_count() and height height_hist.bin_count()
• histograms will be reset (zeroed) here, so it does not matter, if they were used before and contain Data

pub fn reset(&mut self)

Reset

• resets histograms
• heatmap is reset to contain only 0’s
• miss_count is reset to 0

pub fn combine<OtherHW, OtherHH>( &mut self, other: &HeatmapUsize<OtherHW, OtherHH> ) -> Result<(), HeatmapError>

where OtherHW: Histogram, OtherHH: Histogram,

“combine” heatmaps

• heatmaps will be combined by adding all entrys of other to self
• heatmaps have to have the same dimensions

pub fn total(&self) -> usize

counts how often the heatmap was hit

• should be equal to self.heatmap.iter().sum::<usize>() but more efficient
• Note: it calculates this in O(min(self.width, self.height))

pub fn total_misses(&self) -> usize

Counts how often the Heatmap was missed, i.e., you tried to count a value (x,y), which was outside the Heatmap

pub fn bins_hit(&self) -> usize

counts how many bins of the heatmap where hit at least once

pub fn bins_not_hit(&self) -> usize

counts how many bins of the heatmap where never hit

pub fn heatmap(&self) -> &Vec<usize>

returns heatmap

• each vector entry will contain the number of times, the corresponding bin was hit
• an entry is 0 if it was never hit

Access indices; understanding how the data is mapped

• A specific heatmap location (x,y) corresponds to the index y * self.width() + x
• you can use the heatmap_index function to calculate the index

pub fn vec_normalized(&self) -> Vec<f64>

returns Vector representing normalized heatmap

• Vector contains only 0.0, if nothing was in the heatmap
• otherwise the sum of this Vector is 1.0 (or at least very close to 1.0)

Access indices; understanding how the data is mapped

• A specific heatmap location (x,y) corresponds to the index y * self.width() + x
• you can use the function heatmap_index(width, x, y) for calculating the index

pub fn heatmap_normalized(&self) -> HeatmapF64<HistWidth, HistHeight>

where HistHeight: Clone, HistWidth: Clone,

returns normalized heatmap

• returns normalized heatmap as HeatmapF64
• Heatmap vector self.heatmap_normalized().heatmap() contains only 0.0, if nothing was in the heatmap
• otherwise the sum of this Vector is 1.0 (within numerical errors)

pub fn into_heatmap_normalized(self) -> HeatmapF64<HistWidth, HistHeight>

returns normalized heatmap

• returns normalized heatmap as HeatmapF64
• Heatmap vector self.heatmap_normalized().heatmap() contains only 0.0, if nothing was in the heatmap
• otherwise the sum of this Vector is 1.0 (within numerical errors)

pub fn vec_normalized_columns(&self) -> Vec<f64>

returns vector representing heatmap, normalized column wise

• Vector contains only 0.0, if nothing was in the heatmap
• otherwise the sum of each column (fixed x) will be 1.0 (within numerical errors), if it contained at least one hit. If it did not, the column will only consist of 0.0

Access indices; understanding how the data is mapped

A specific heatmap location (x,y) corresponds to the index y * self.width() + x

• you can use the function heatmap_index(width, x, y) for calculating the index

pub fn heatmap_normalized_columns(&self) -> HeatmapF64<HistWidth, HistHeight>

where HistHeight: Clone, HistWidth: Clone,

returns (column wise) normalized heatmap

• returns normalized heatmap as HeatmapF64
• Heatmap vector self.heatmap_normalized().heatmap() contains only 0.0, if nothing was in the heatmap
• otherwise the sum of each column (fixed x) will be 1.0 (within numerical errors), if it contained at least one hit. If it did not, the column will only consist of 0.0
• otherwise the sum of this Vector is 1.0

pub fn into_heatmap_normalized_columns( self ) -> HeatmapF64<HistWidth, HistHeight>

returns (column wise) normalized heatmap

• returns normalized heatmap as HeatmapF64
• Heatmap vector self.heatmap_normalized().heatmap() contains only 0.0, if nothing was in the heatmap
• otherwise the sum of each column (fixed x) will be 1.0 (within numerical errors), if it contained at least one hit. If it did not, the column will only consist of 0.0
• otherwise the sum of this Vector is 1.0

pub fn vec_normalized_rows(&self) -> Vec<f64>

returns vector representing heatmap, normalized row wise

• Vector contains only 0.0, if nothing was in the heatmap
• otherwise the sum of each row (fixed x) will be 1.0 (within numerical errors), if it contained at least one hit. If it did not, the row will only consist of 0.0

Access indices; understanding how the data is mapped

A specific heatmap location (x,y) corresponds to the index y * self.width() + x

• you can use the function heatmap_index(width, x, y) for calculating the index

pub fn heatmap_normalized_rows(&self) -> HeatmapF64<HistWidth, HistHeight>

where HistHeight: Clone, HistWidth: Clone,

returns (row wise) normalized heatmap

• returns normalized heatmap as HeatmapF64
• Heatmap vector self.heatmap_normalized().heatmap() contains only 0.0, if nothing was in the heatmap
• otherwise the sum of each row (fixed x) will be 1.0 (within numerical errors), if it contained at least one hit. If it did not, the row will only consist of 0.0
• otherwise the sum of this Vector is 1.0

pub fn into_heatmap_normalized_rows(self) -> HeatmapF64<HistWidth, HistHeight>

returns (row wise) normalized heatmap

• returns normalized heatmap as HeatmapF64
• Heatmap vector self.heatmap_normalized().heatmap() contains only 0.0, if nothing was in the heatmap
• otherwise the sum of each row (fixed x) will be 1.0 (within numerical errors), if it contained at least one hit. If it did not, the row will only consist of 0.0
• otherwise the sum of this Vector is 1.0

pub fn count_multiple<A, B, X, Y, I>( &mut self, width_val_iter: I, height_val: B ) -> Result<usize, HeatmapError>

where HistWidth: HistogramVal<X>, HistHeight: HistogramVal<Y>, A: Borrow<X>, B: Borrow<Y>, I: Iterator<Item = A>,

update the heatmap

• calculates the coordinates (x, y) of the bin corresponding to the given values pair (width_iter_entry, height_val)
• as soon as a coordinate is encountered that is out of bounds, it counts a “miss” and returns the HeatmapError, aborting further execution
• otherwise it counts the “hits” and returns the total number of hits added usize

pub fn count<A, B, X, Y>( &mut self, width_val: A, height_val: B ) -> Result<(usize, usize), HeatmapError>

where HistWidth: HistogramVal<X>, HistHeight: HistogramVal<Y>, A: Borrow<X>, B: Borrow<Y>,

update the heatmap

• calculates the coordinate (x, y) of the bin corresponding to the given value pair (width_val, height_val)
• if coordinate is out of bounds, it counts a “miss” and returns the HeatmapError
• otherwise it counts the “hit” and returns the coordinate (x, y)

pub fn write_to<W>(&self, data_file: W) -> Result<()>

where W: Write,

Write heatmap to file

• writes data of heatmap to file.

file

• lets assume self.width()is 4 and self.height() is 3
• the resulting file could look like

0 1 0 10
100 0 0 1
2 9 1 0

pub fn gnuplot_quick<W>(&self, writer: W) -> Result<()>

where W: Write,

Create a gnuplot script to plot your heatmap

• writer: The gnuplot script will be written to this
• gnuplot_output_name: how shall the file, created by executing gnuplot, be called? Ending of file will be set automatically

Note

• This is the same as calling gnuplot with default GnuplotSettings
• The default axis are the bin indices, which, e.g, means they always begin at 0. You have to set the axis via the GnuplotSettings

pub fn gnuplot<W, GS>(&self, gnuplot_writer: W, settings: GS) -> Result<()>

where W: Write, GS: Borrow<GnuplotSettings>,

Create a gnuplot script to plot your heatmap

This function writes a file, that can be plotted via the terminal via gnuplot

gnuplot gnuplot_file

Parameter:

• gnuplot_writer: writer gnuplot script will be written to
• gnuplot_output_name: how shall the file, created by executing gnuplot, be called? Ending of file will be set automatically
• settings: Here you can set the axis, choose between terminals and more. I recommend that you take a look at GnuplotSettings

Note

The default axis are the bin indices, which, e.g, means they always begin at 0. You have to set the axis via the GnuplotSettings

Example

use rand_pcg::Pcg64;
use rand::{SeedableRng, distributions::*};
use sampling::*;
use std::fs::File;
use std::io::BufWriter;
 
// first randomly create a heatmap
let h_x = HistUsizeFast::new_inclusive(0, 10).unwrap();
let h_y = HistU8Fast::new_inclusive(0, 10).unwrap();

let mut heatmap = HeatmapU::new(h_x, h_y);
heatmap.count(0, 0).unwrap();
heatmap.count(10, 0).unwrap();

let mut rng = Pcg64::seed_from_u64(27456487);
let x_distr = Uniform::new_inclusive(0, 10_usize);
let y_distr = Uniform::new_inclusive(0, 10_u8);

for _ in 0..100000 {
    let x = x_distr.sample(&mut rng);
    let y = y_distr.sample(&mut rng);
    heatmap.count(x, y).unwrap();
}
 
// create File for gnuplot script
let file = File::create("heatmap.gp").unwrap();
let buf = BufWriter::new(file);

// Choose settings for gnuplot
let mut settings = GnuplotSettings::new();
settings.x_axis(GnuplotAxis::new(-5.0, 5.0, 6))
    .y_axis(GnuplotAxis::from_slice(&["a", "b", "c", "d"]))
    .y_label("letter")
    .x_label("number")
    .title("Example")
    .terminal(GnuplotTerminal::PDF("heatmap".to_owned()));

// create gnuplot script
heatmap.gnuplot(
    buf,
    settings
).unwrap();

gnuplot script can now be plotted with

gnuplot heatmap.gp

Trait Implementations

impl<HistWidth: Clone, HistHeight: Clone> Clone for HeatmapUsize<HistWidth, HistHeight>

fn clone(&self) -> HeatmapUsize<HistWidth, HistHeight>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<HistWidth: Debug, HistHeight: Debug> Debug for HeatmapUsize<HistWidth, HistHeight>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, HistWidth, HistHeight> Deserialize<'de> for HeatmapUsize<HistWidth, HistHeight>

where HistWidth: Deserialize<'de>, HistHeight: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<HistWidth, HistHeight> From<HeatmapUsize<HistWidth, HistHeight>> for HeatmapF64<HistWidth, HistHeight>

where HistWidth: Histogram, HistHeight: Histogram,

fn from(other: HeatmapU<HistWidth, HistHeight>) -> Self

Converts to this type from the input type.

impl<HistWidth, HistHeight> Serialize for HeatmapUsize<HistWidth, HistHeight>

where HistWidth: Serialize, HistHeight: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.