.. _`Heatmap calculation`:

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

Heatmap calculation
```````````````````

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


Calculate a 2d histogram or other heatmap of a givensignal.




Documentation
:::::::::::::

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

The inputs X, Y and Z (if selected) data columns must be of numeric,
datetime or timedelta types. X and Y data columns may not be of type
complex.

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.


Definition
::::::::::


Input ports
...........

    **in**  table
        Input data


Output ports
............

    **out**  table
        Heatmap data




Configuration
.............

    **Auto range** (auto_range)
        When checked, use data range as histogram range
    **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
    **X data column:** (x_data_column)
        Select X axis data. Requires numeric, datetime or timedelta type.
    **X max:** (x_max)
        Set maximum X value
    **X min:** (x_min)
        Set minimum X value
    **Y Bins:** (y_bins)
        Number of bins on the y axis
    **Y data column:** (y_data_column)
        Select Y axis data. Requires numeric, datetime or timedelta type.
    **Y max:** (y_max)
        Set maximum Y value
    **Y min:** (y_min)
        Set minimum Y value
    **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. Requires numeric, datetime or timedelta type. For "Count (histogram)" no z data column is needed.







Examples
........

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




Implementation
..............

.. automodule:: node_heatmap_calculation
    :noindex:

.. class:: HeatmapCalculation
    :noindex: