.. _`Heatmap calculation`:

.. _`org.sysess.sympathy.dataanalysis.heatmapcalc`:

Heatmap calculation
~~~~~~~~~~~~~~~~~~~

.. image:: heatmap_calculation.svg
   :width: 48


This node calculates a 2D histogram or other heatmap of a given signal.

The output consists of bin edges and bin values and can for instance be
used in a heatmap plot in the node :ref:`Figure`.

This node ignores any rows in the input where one or more of the selected
columns are masked.

*Input ports*:
    :in: table

        Input data

*Output ports*:
    :out: table

        Heatmap data

*Configuration*:
    **X data column:** (x_data_column)
        Select X axis data
    **Y data column:** (y_data_column)
        Select Y axis data
    **Z data column:** (z_data_column)
        The data points of the z data are placed in bins according to the cooresponding values of x and y. They are then reduced to a single bin value using the selected reduction function. For "Count (histogram)" no z data column is needed.
    **Reduction function:** (reduction)
        A function used on all the z data points in a bin. For "Count (histogram)" no z data column is needed.
    **X Bins:** (x_bins)
        Number of bins on the x axis
    **Y Bins:** (y_bins)
        Number of bins on the y axis
    **Auto range** (auto_range)
        When checked, use data range as histogram range
    **X min:** (x_min)
        Set minimum X value
    **X max:** (x_max)
        Set maximum X value
    **Y min:** (y_min)
        Set minimum Y value
    **Y max:** (y_max)
        Set maximum Y value

.. automodule:: node_heatmap_calculation

.. class:: HeatmapCalculation


Example flows
#############

* :download:`HeatmapCalculation.syx </_examples/Sympathy/Analysis/Statistic/HeatmapCalculation.syx>`