Skip to content

Class Heatmap

ClassList > Heatmap

Marker metric used to enable the heatmap output. More...

  • #include <bench_heatmap.h>

Inherits the following classes: Metric

Public Functions

Type Name
Heatmap ()
Construct the metric with label "Heatmap".
virtual void compute (const Mesh &, const Mesh &, benchmark::State &) override const
No-op (heatmapping is driven by BenchmarksContainer ).
~Heatmap () = default

Public Functions inherited from Metric

See Metric

Type Name
Metric (const std::string & name)
Construct a metric with the given short label.
virtual void compute (const Mesh & originalMesh, const Mesh & reconstructedMesh, benchmark::State & state) const = 0
Compute the metric for a single (original, reconstructed) pair.
const std::string & getName () const
Return the metric's short label.
virtual ~Metric () = default

Detailed Description

The actual heatmap work is performed in BenchmarksContainer, not by this class: when the metric list contains a metric named "Heatmap", the container subdivides the reconstructed mesh with VertexToFace::addMidEdgeVertices and uses VertexToFace::compute to derive per-vertex texture coordinates, which are then written as vt lines in the reconstructed OBJ file.

Heatmap::compute itself is a no-op since the metric does not record any counter.

Public Functions Documentation

function Heatmap

Construct the metric with label "Heatmap".

inline Heatmap::Heatmap () 


function compute

No-op (heatmapping is driven by BenchmarksContainer ).

inline virtual void Heatmap::compute (
    const Mesh &,
    const Mesh &,
    benchmark::State &
) override const

Implements Metric::compute


function ~Heatmap

Heatmap::~Heatmap () = default


The documentation for this class was generated from the following file benchmark/metrics/implementations/bench_heatmap.h