.. _`Histogram calculation`:

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

Histogram calculation
~~~~~~~~~~~~~~~~~~~~~

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


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

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

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

*Ports*:

    **Inputs**:

        :in: table

            Input data

    **Outputs**:

        :out: table

            Histogram data

*Configuration*:

    **data_column**
        Column to create histogram for.
    **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.
    **bins**
        Number of bins.
    **auto_range**
        When checked, use data range as histogram range.
    **x_min**
        Minimum x value.
    **x_max**
        Maximum x value.
    **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.

.. automodule:: node_histogram_calculation

.. class:: HistogramCalculation