.. _`Histogram calculation`:

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

Histogram calculation
`````````````````````

.. image:: histogram_calculation.svg
   :width: 48


Calculate the histogram of a given signal.




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

This node takes a table and calculates a histogram from one of its columns.

The input Data column must be of numeric, datetime or timedelta type.
Weights column (if selected) must be of numeric type.

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

Masked values in the data column are ignored. Masked values in the weights
column are treated as 1.


Definition
::::::::::


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

    **in**  table
        Input data


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

    **out**  table
        Histogram data




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

    **Auto range** (auto_range)
        When checked, use data range as histogram range.
    **Bins:** (bins)
        Number of bins.
    **Data column:** (data_column)
        Column to create histogram for. Requires numeric, datetime or timedelta type.
    **Density** (normed)
        When checked, the result is the value of the probability density function at each bin, normalized such that the integral of the histogram is 1.
    **Weights column:** (weights_column)
        If you choose a weights column, each value in the data column only contributes its associated weight towards the bin count, instead of 1. Requires numeric type.
    **X max:** (x_max)
        Maximum x value.
    **X min:** (x_min)
        Minimum x value.







Examples
........

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




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

.. automodule:: node_histogram_calculation
    :noindex:

.. class:: HistogramCalculation
    :noindex: