pub struct HeatmapF64<HistWidth, HistHeight> { /* private fields */ }
Expand description

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

Use this to get a “flipped” heatmap
Use this to get a “flipped” heatmap
  • transposes the heatmap inplace

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

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
row of the heatmap
  • returns reference of Slice of the specifed row of the heatmap without checking for bounds
  • Generally not recommended, use with caution!
Safety

Calling this with out-of-bounds index will result in undefined behavior!

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

Safety

undefined behavior if coordinates are out of bounds

returns width of the heatmap
  • the width is the same size, as the self.width_projection().bin_count()
returns height of the heatmap
  • the height is the same size, as the self.height_projection().bin_count()
Returns reference to current width Histogram
  • statistical information of how often a count hit a specific width
Returns reference to current height Histogram
  • statistical information of how often a count hit a specific height
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
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
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
Reset
  • resets histograms
  • heatmap is reset to contain only 0’s
  • miss_count is reset to 0
“combine” heatmaps
  • heatmaps have to have the same dimensions
  • miss counts of other will be added to self
  • with and hight histogram counts will be added to self
  • self.heatmap will be modified at each index by self.heatmap[i] = combine_fn(self.heatmap[i], other.heatmap[i])
Usecase
  • e.g. if you want to add, subtract or multiply two heatmaps
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))
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
Normalizes self
  • Afterwards sum over all entrys (within numerical precision) should be 1.0
Normalizes self
  • Afterwards the sum of each column (fixed x) will be 1.0, if the sum of the row was not 0.0 before If it did not, the column will only consist of 0.0
Normalizes self
  • Afterwards the sum of each row (fixed y) will be 1.0, if the sum of the row was not 0.0 before
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” (by adding val to the heatmap at the corresponding location) and returns the coordinate (x, y) of the hit
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 1.0 0.0 10.0
100.0 0.2 0.3 1.1
2.2 9.3 1.0 0.0
Create a gnuplot script to plot your heatmap
  • writer: The gnuplot script will be written to this
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
Create a gnuplot script to plot your heatmap

This function writes a file, that can be plottet 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
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 skript
let file = File::create("heatmap_normalized.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_normalized".to_owned()));

 
// norm heatmap row wise - this converts HeatmapU to HeatmapfF64
let heatmap = heatmap.into_heatmap_normalized_rows();

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

Skript can now be plotted with

gnuplot heatmap_normalized.gp

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Deserialize this value from the given Serde deserializer. Read more
Converts to this type from the input type.
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Cast from Self to T
Try converting from Self to T
Cast to integer, truncating Read more
Cast to the nearest integer Read more
Cast the floor to an integer Read more
Cast the ceiling to an integer Read more
Try converting to integer with truncation Read more
Try converting to the nearest integer Read more
Try converting the floor to an integer Read more
Try convert the ceiling to an integer Read more
Convert from T to Self
Try converting from T to Self

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The alignment of pointer.
The type for initializers.
Initializes a with the given initializer. Read more
Dereferences the given pointer. Read more
Mutably dereferences the given pointer. Read more
Drops the object pointed to by the given pointer. Read more
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.