Benutzer-Werkzeuge

Webseiten-Werkzeuge


de:software:matlab:tsim:doc:format:index

Inhaltsverzeichnis

Datenformat des Moduls

Alle Datensätze werden innerhalb der trEPR-Toolbox in einem einheitlichen Format abgelegt und verarbeitet. Das TSim-Modul erweitert dieses Datenformat um eigene Felder.

Diese Seite dient der Dokumentation der Spezifikation dieser Erweiterungen des trEPR-Toolbox-Datenformates.

Historie

Ein kurzer Abriß über die Änderungen im Datenformat des TSim-Moduls der trEPR-Toolbox in absteigender Reihenfolge der Änderungen.

  • 2013-10-03: Version 0.4 – Struktur erweitert
    • addsimpar unter sim
  • 2013-09-13: Version 0.3 – Struktur erweitert
    • remarks mit Feldern purpose und comment
  • 2013-09-12: Version 0.2 – Struktur erweitert
    • fitini und fitopt
    • routine unter sim und fit
  • 2013-08-16: Version 0.1 – Erster Entwurf der Struktur

Struktur

Im Wesentlichen werden alle Felder in einer Matlab®-Struktur mit dem Modulnamen (TSim) in der Wurzel der Datenstruktur der trEPR-Toolbox verankert. Darüber hinaus wird es ein zusätzliches, ebenfalls in der Wurzel der Datenstruktur der trEPR-Toolbox verankertes Feld geben, das zur Aufnahme der simulierten Spektren dient.

  • TSim - struct
    Parameter, die spezifisch für das TSim-Modul sind
    • sim - struct
      Parameter, die für die Simulation notwendig und hinreichend sind
      • Sys - struct
        Parameter, die das Spinsystem definieren, in EasySpin-Notation
        • S - scalar
          Spinmultiplizität – für Triplett-Spektren immer 1
        • g - vector 3×1
          Hauptwerte des g-Tensors
        • D - vector 3×1
          Hauptwerte des D-Tensors
      • Exp - struct
        Experimentelle Parameter in EasySpin-Notation
        • mwFreq - scalar
          Mikrowellenfrequenz in GHz
        • Range - vector 2×1
          Start- und Endwerte des Magnetfeldes, für das die Simulation berechnet werden soll, in mT
        • nPoints - scalar
          Zahl der Punkte auf der Magnetfeldachse
        • Harmonic - scalar
          Harmonische, die berechnet/dargestellt werden soll.
          Für spinpolarisierte Triplett-Spektren immer 0
        • Temperature - vector 3×1
          Populationen der Triplett-Niveaus (im Hochfeld?)
      • addsimpar - cell array
        (interner) Name zusätzlicher (nicht notwendiger) Simulationsparameter
      • routine - string
        Name der verwendeten Simulationsroutine
    • fit - struct
      Fitspezifische Parameter
      • inipar - vector
        Startwerte der zu fittenden Simulationsparameter
      • fittedpar - vector
        Endwerte der zu fittenden Simulationsparameter
      • fitini - struct
        • fitpar - vector
          Endwerte der zu fittenden Simulationsparameter
        • tofit - boolean vector
          Entscheidung über zu fittende Simulationsparameter
        • lb - vector
          untere Fitgrenzen
        • ub - vector
          obere Fitgrenzen
        • fitparameters - cell array
          (interner) Name der Fitparameter
      • fitopt - struct
        Fitoptionen für die Fitmethode (lsqcurvefit)
        • MaxIter - scalar
          Maximale Zahl der Iterationen
        • TolFun - scalar
      • routine - string
        Name der verwendeten Fitroutine
    • remarks - struct
      Vom Nutzer eingegebener Text
      • purpose - string
        Zielstellung (tendenziell ein kurzer Satz)
      • comment - cell array
        (ausführlicherer) Kommentar
    • format - struct
      Details zum Format der Datenstruktur
      • name - string
        Name des Datenformates
      • version - string
        Versionsnummer der Datenstruktur1)
  • calculated - matrix/vector
    Berechnetes Spektrum2)

Hilfsmittel

Es gibt eine Funktion trEPRTSim_dataStructure() – vergleichbar der Funktion trEPRdataStructure() der trEPR-Toolbox –, die den Umgang mit der für das Modul spezifischen Datenstruktur regelt. Aus der Hilfe zu dieser Funktion:

  trEPRTSim_dataStructure Return data structure for trEPR TSim module, or
  test compliance of given structure with the data structure of the module.
 
  Usage
    structure = trEPRTSim_dataStructure;
    structure = trEPRTSim_dataStructure(<command>)
    [missingFields,wrongType] = trEPRTSim_dataStructure(<command>,structure)
 
    <command> - string 
                one of 'structure', 'model' or 'check'
                'structure' - return (empty) trEPR toolbox data structure
                'model' -     return trEPR toolbox data structure with
                              field types as values
                'check' -     check given structure for compliance with the
                              toolbox data structure
 
    structure - struct
                either empty trEPR toolbox data structure or 
                trEPR toolbox data structure with field types as values
 
    missingFields - cell array
                    List of fields missing in the structure with respect to
                    the toolbox data structure
 
    wrongType -     cell array
                    List of fields in structure having the wrong type with
                    respect to the toolbox data structure
 
  See also trEPRload, trEPRdataStructure.
1)
Eine Versionsnummer der Datenstruktur des Moduls, die unabhängig von der Version des Moduls ist, ist zur Kompatibilität bei Veränderungen der Datenstruktur sehr hilfreich.
2)
Dieses Feld sollte auf Dauer in die generische trEPR-Toolbox-Datenstruktur aufgenommen werden, da es unabhängig vom konkreten Modul für Simulationen ist und von der Toolbox selbst verstanden werden sollte.
de/software/matlab/tsim/doc/format/index.txt · Zuletzt geändert: von 127.0.0.1