.. _auto_curve_histogram:

*BIN Y-VALUES*
==============

Bins the Y-values of an input curve into a histogram, returning the bin counts as a key-value result. Use this worker to analyse the distribution of any time-history or signal by specifying the desired number of bins and whether the bin range starts at zero.

When to use
-----------

Classification: **process**.

Tagged: ``binning``, ``curve``, ``distribution``, ``histogram``, ``signal``, ``transformations``, ``y-values``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Curve In
     - curve_in
     - vector
     - —
     - 
     - Input curve whose Y-values will be binned; accepts any (X, Y) vector such as a time-history or signal channel.
   * - Number Of Bins
     - numberof_bins
     - scalar
     - —
     - 
     - Integer number of equal-width bins to divide the Y-value range into; defaults to an auto-selected count when left blank.
   * - Use Zero-min
     - usezero-min
     - list
     - yes
     - 
     - Whether to force the histogram's lower bound to zero ('yes') or use the actual minimum Y-value as the lower bound ('no'); defaults to 'yes'.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - curve_histogram_output_1
     - curve_histogram_output_1
     - keyvalue
     - Key-value map where each key is a bin label (range of Y-values) and the corresponding value is the count of Y-samples falling in that bin.

Disciplines
-----------

- data.curve.transform
- data.signal_processing
- data.statistics

Runnable example
----------------

A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: `/api/workflow/example?id=curve_histogram <https://www.d3view.com/api/workflow/example?id=curve_histogram>`_

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>transformation</code> schema. Worker id: <code>curve_histogram</code>. Schema hash: <code>d1d943954618</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>