.. _`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 from Table`.

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

*Ports*:

    **Inputs**:

        :in: table

            Input data

    **Outputs**:

        :out: table

            Heatmap data

*Configuration*:

    **x_data_column**
        Select X axis data
    **y_data_column**
        Select Y axis data
    **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**
        A function used on all the z data points in a bin. For "Count (histogram)" no z data column is needed.
    **x_bins**
        Number of bins on the x axis
    **y_bins**
        Number of bins on the y axis
    **auto_range**
        When checked, use data range as histogram range
    **x_min**
        Set minimum X value
    **x_max**
        Set maximum X value
    **y_min**
        Set minimum Y value
    **y_max**
        Set maximum Y value

.. automodule:: node_heatmap_calculation

.. class:: HeatmapCalculation