.. highlightlang:: us

.. index:: nc_varinq_info

.. _nc_varinq_info:

nc_varinq_info
==============

.. us.tag  nc_varinq_info GERMAN NC_Var New5400 Changed5704

:ref:`nc_varinq_info` liefert Informationen zu den Werten eines Kanals (Minimum, 
Maximum, Monotonie und ob der Kanal fehlende Werte enthält).

.. function::  value = nc_varinq_info(ncid, varid, ssInfo)

.. us.return

**Returnwert**

*value* ist der zu *ssInfo* gehörende Wert.

Im Fehlerfall liefert die Funktion eine Zahl < 0 zurück. Mit der Funktion
:ref:`nc_last_error` kann dann überprüft werden, ob ein Fehler aufgetreten ist,
oder ob dies ein gültiger min/max-Wert ist.

.. us.params

**Parameter**

.. uparam:: ncid

   *ncid* ist die Zugriffsnummer, die von einem erfolgreichen Aufruf der
   Funktionen :ref:`nc_create` oder :ref:`nc_open` geliefert wurde.

.. uparam:: varid

   *varid* ist die Identifikations-Nummer einer Variablen.

.. uparam:: ssInfo

   *ssInfo* ist einer der folgenden Strings:

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

      * - Wert
        - Beschreibung
      * - ``"min"``
        - *value* ist der kleinste Wert im Kanal.
      * - ``"max"``
        - *value* ist der größte Wert im Kanal.
      * - ``"monotone"``
        - *value* ist 1, wenn die Werte im Kanal monoton aufsteigend sind. 
          Monoton ist der Kanal wenn alle x[i] <= x[i+1] sind.
          
          *value* ist 2, wenn die Werte im Kanal streng monoton aufsteigend sind. 
          Streng monoton ist der Kanal wenn alle x[i] < x[i+1] sind.

          *value* ist 0, wenn die Werte nicht monoton aufsteigend sind.

      * - ``"has_missings"``
        - *value* ist 1, wenn der Kanal mindestens einen "missing-Value" enthält
          und 0, wenn keine "missing-Values" im Kanal enthalten sind.

          Wenn alle Werte "missing-Values" sind ist *value* gleich 2. "min",
          "max" liefern dann den Wert 1e10 und "monotone" liefert den Wert 1.
          Falls alle Werte bis auf einen  "missing-Values" sind, ist "min" und
          "max" dieser Wert und "monotone" ist 1.

      * - ``"reduced"``
        - *value* ist ein double-Array mit reduzierten Daten. Es werden von
          jeweils 2000 Werten des Kanals der Minimalwert und der Maximalwert
          ermittelt. Bei einem Kanal von 10 Millionen Punkten werden also 10.000
          Punkte geliefert. Die reduzierten Daten werden nur bei Kanälen mit mehr
          als 2.000.000 Punkten erzeugt.

.. us.comment

**Kommentar**

Diese Funktion kann nur bei UniPlot-Datendateien verwendet werden. Siehe 
:ref:`nc_create`. 

Bei netCDF-Dateien (NC_FORMAT_CLASSIC und NC_FORMAT_PC) liefert die Funktion
immer -1.

Die Funktion erzeugt die Kanalattribute ``nc_min``, ``nc_max``, ``nc_monotone``,
``nc_has_missings`` und ``nc_change_counter`` falls sie nicht bereits vorhanden
sind. Bei Kanälen mit mehr als 2.000.000 Punkten wird das außerdem das Attribut
``nc_reduced`` erzeugt.

Die Funktion prüft ob die Werte aktuell sind, indem sie den Change-Counter des
Kanals (siehe :ref:`nc_varinq_changed`) mit dem Attribut ``nc_change_counter``
vergleicht. Bei Ungleichheit werden die ``min/max/monoton/missing``-Werte neu 
ermittelt, sonst werden die entsprechenden Attribut-Werte zurück gegeben. 

Falls die Attribute nicht vorhanden oder nicht aktuell sind, muss die Datei mit 
Schreibzugriff geöffnet worden sein.

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - R2015.4 (5.70.4)
     - Reduzierte Daten ("reduced").
   * - R2012 (5.40.0)
     - Neu

.. seealso::
   :ref:`uberblick-netcdf-dateien`,
   :ref:`nc_open`,
   :ref:`nc_create`,
   :ref:`nc_last_error`,
   :ref:`nc_varinq_changed`

:sub:`id-1516507`