.. highlightlang:: us

.. _nc_createmeancyclefile:

NC_CreateMeanCycleFile
======================

.. index:: NC_CreateMeanCycleFile

.. us.tag  NC_CreateMeanCycleFile GERMAN nc.tools New5151

:ref:`NC_CreateMeanCycleFile` erzeugt eine NC-Datei mit gemittelten Zyklen. 
Die zyklischen Daten werden aus einer NC-Datei gelesen. Die nötigen Parameter
werden in einem Objekt übergeben.

.. function::  ssNCMean = NC_CreateMeanCycleFile(ncid, obj)
               ssNCMean = NC_CreateMeanCycleFile(ssNCFile, obj);

.. us.return

**Returnwert**

Ist der Name der erzeugten NC-Datei oder ein leerer String, falls ein
Fehler aufgetreten ist.

.. us.params

**Parameter**

.. uparam:: ssNCFile

   *ssNCFile* ist der Name einer NC-Datei mit Daten mit mehreren Zyklen.

.. uparam:: ncid

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

.. uparam:: obj

   *obj* ist ein Objekt mit den folgenden Elementen:

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

      * - Name
        - Bedeutung
      * - obj.ssNCDestName
        - Vollständiger Dateiname der Zieldatie. Falls das Element nicht existiert oder einen leerer String enthält wird die Datei im Verzeichnis der Quelldatei gespeichert
      * - obj.ssXChannel
        - Name des Kanals mit den x-Koordinaten, z. B. Zeit oder Kurbelwinkel bei Indizierdaten.
      * - obj.svMeanChannel
        - String-Vektor mit den Kanalname, die gemittelt werden sollen.
      * - obj.rsStartCycle
        - Erster Datenpunkt, bei dem ein Zyklus beginnt. Der Punkt muss innerhalb der Messdaten liegen.
      * - obj.rsCycleLength
        - Länger einer Periode.
      * - obj.svCycles
        - String, der die Zyklen festlegt, die gemittelt werden sollen. Es können einzelne Zyklen oder Bereiche festgelegt werden. Beispiel: ``3,6,10-15``. Um alle Zyklen zu mitteln, geben Sie den Text ``All`` ein.
      * - obj.bMean
        - Mittelwert berechnen, TRUE (1) oder FALSE (0)
      * - obj.bMaximum
        - Maximum berechnen, TRUE (1) oder FALSE (0)
      * - obj.bMinimum
        - Minimum berechnen, TRUE (1) oder FALSE (0)

.. us.example

**Beispiel**

::

  def TestMean()
  {
	ssIFile = "z:/uniplot-testdata/ifile-daten/1000_023.001"
	ssNCFile = auto_ImportData(ssIFile);
	if (ssNCFile == "") {
		return FALSE;
	}

	ncid = nc_open(ssNCFile, NC_WRITE);
	if (ncid == -1) {
		return FALSE;
	}

	obj = [.];
	obj.ssNCDestName = ssIFile + "_mean.nc";
	obj.ssXChannel = "CA";
	obj.rsStartCycle = -360;
	obj.rsCycleLength = 720;
	obj.svCycles = "All"; 
	obj.bMean = 1;
	obj.bMaximum = 1;
	obj.bMinimum = 1;
	obj.svMeanChannel = ["P_ZYL1", "P_ZYL2", "P_ZYL3", "P_ZYL4"];

	ssNCMean = NC_CreateMeanCycleFile(ncid, obj);
	nc_close(ncid);
	
	return ssNCMean;
  }

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - 5.15.1
     - Neu.

.. seealso::
   :ref:`uberblick-netcdf-dateien`,
   :ref:`dateidaten-exportieren`,
   :ref:`nc_create`,
   :ref:`dateneditormittelwert-zyklus`

:sub:`id-1363952`