.. highlightlang:: us

.. _histogram:

histogram
=========

.. index:: histogram

.. us.tag  histogram GERMAN New530  math-base

:ref:`histogram` berechnet das Histogramm eines Vektors.

.. function::  rmXY = histogram(rmY)
    rmXY = histogram(rmY, bins)
    rmXY = histogram(rmY, bins, nType)
    rmXY = histogram(rmY, bins, nType, bCenterBin)
    rmXY = histogram(rmY, bins, nType, bCenterBin, hLayer)

.. us.return

**Returnwert**

*rmXY* ist eine Matrix mit zwei Spalten. Spalte 1 enthält die 
Klassenmitten und Spalte 2 die Häufigkeitswerte. 

.. us.params

**Parameter**

.. uparam:: rmY

   *rmY* ist eine reelle Matrix. Aus der letzten Spalte der Matrix wird
   das Histogramm berechnet.

.. uparam:: bins

   *bins* ist entweder ein skalarer Wert mit der Klassenanzahl oder
   eine Liste mit den Klassenmitten oder Klassengrenzen. Defaultwert ist 10.

.. uparam:: nType

   *nType* legt des Typ des Histogramms fest:

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

      * - Typ
        - Beschreibung
      * - nType = 1
        - Absolut
      * - nType = 2
        - Prozent
      * - nType = 3
        - kumulativ (mehr als)
      * - nType = 4
        - kumulativ in Prozent (mehr als)
      * - nType = 5
        - kumulativ (weniger als)
      * - nType = 6
        - kumulativ in Prozent (weniger als)

   Defaultwert ist 1.

.. uparam:: bCenterBin

   Falls *bCenterBin* TRUE (1) ist, werden die Werte in *bin* als Klassenmitten
   verwendet. Falls *bCenterBin* FALSE (0) ist, werden die Werte in *bin* als 
   Klassengrenzen verwendet. Defaultwert ist FALSE;
   Beispiel für *bCenterBin*  = TRUE:
   bins: 2,4,6,8  Klassengrenzen: 1 bis 3, 3 bis 5, 5 bis 7, 7 bis 9
   Beispiel für *bCenterBin*  = FALSE:
   bins: 2,4,6,8  Klassengrenzen: 2 bis 4, 4 bis 6, 6 bis 8

.. uparam:: hLayer

   Falls *hLayer* = 0 ist, wird ein Diagramm mit dem Histogramm erzeugt.
   Falls *hLayer* > 0 ist, wird der Histogramm in das Diagramm mit dem Handle 
   *hLayer* eingefügt. Für diesen beiden Fälle gibt die Funktion im Parameter 
   *rmXY* den Handle des Datensatzes zurück. Falls *hLayer* = -1 ist, wird kein 
   Datensatz erzeugt. Defaultwert ist -1;

.. us.example

**Beispiel**

::

   * srand(0)
       1.0000
   * histogram(rand(10,1), 0:0.1:1, 1, TRUE)
   0.0000  0.0000
   0.1000  0.0000
   0.2000  2.0000
   0.3000  1.0000
   0.4000  0.0000
   0.5000  0.0000
   0.6000  1.0000
   0.7000  2.0000
   0.8000  3.0000
   0.9000  1.0000
   1.0000  0.0000

   * srand(0)
       1.0000
   * histogram(rand(10,1), 0:0.1:1, 1, FALSE)
   0.0500  0.0000
   0.1500  1.0000
   0.2500  2.0000
   0.3500  0.0000
   0.4500  0.0000
   0.5500  1.0000
   0.6500  1.0000
   0.7500  1.0000
   0.8500  4.0000
   0.9500  0.0000

   

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - 5.10.2
     - Neu Typen: 5 kumulativ (weniger als) und 6 kumulativ in Prozent (weniger als) zugefügt.
   * - 5.3.0
     - Neu.

.. seealso::
   :ref:`uberblick-mathematik`,
   :ref:`histc`,
   :ref:`sum`,
   :ref:`cumsum`

:sub:`id-694203`