User Tools

Site Tools


Action disabled: backlink
de:software:matlab:trepr:dev:c:history

Historie

Zielstellung
Zusammenfassung der Parameter für jeden einzelnen Bearbeitungsschritt eines Datensatzes in der Toolbox
Motivation
Grundlage für eine Report-Funktionalität und damit für eine geordnete Dokumentation
Automatische Speicherung sämtlicher Parameter
Problem
Bei der Verarbeitung von Daten in der Toolbox ist es oft interessant, die „Historie“ der durchgeführten Operationen zu kennen und so zusammen mit den Daten im Datensatz abzulegen, daß man jederzeit wieder aus einem Datensatz einen Report generieren kann.
Lösung
Entwicklung der notwendigen Datenstruktur
Automatische Ablage im Datensatz

Lösung

Datenstruktur für den "History Record"

  • date - datetime
    Datum und Uhrzeit der Aktion
  • method - string
    Dateiname der verwendeten Matlab-Funktion
  • system - struct
    Information über das System, auf dem die Aktion durchgeführt wurde
    • username - string
    • platform - string
    • matlab - string
    • trEPR - string
  • parameters - struct
    Parameter, wie sie für die Funktion gebraucht werden
    • method - string
      Zum Skalieren verwendete Methode: „min(diff)„|“time avg“
    • parameters - struct
      Parameter, je nach method unterschiedlich
  • info - struct
    Struktur für weitergehende Informationen

Hilfsmittel

Zur Vereinfachung der Entwicklung neuer Routinen und zum Überprüfen von „History Records“ auf Konformität mit dem Datenmodell der trEPR-Toolbox gibt es mittlerweile eine neue bzw. erweiterte Funktion:

trEPRdataStructure()

Um einen (weitgehend leeren) „History Record“ zu erzeugen, lautet der Aufruf wie folgt:

history = trEPRdataStructure('history');

In dieser Struktur history sind die Felder der Unterstruktur system bereits ausgefüllt, ebenso der Zeitstempel. Alle weiteren Felder müssen von der jeweils aufrufenden Funktion selbständig mit Inhalt gefüllt werden.

Aus der Hilfe zu dieser Funktion:

  trEPRdataStructure Return data structure for trEPR toolbox data, or test
  compliance of given structure with the data structure of the toolbox.
 
  Usage
    structure = trEPRdataStructure;
    structure = trEPRdataStructure(<command>)
    [missingFields,wrongType] = trEPRdataStructure(<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
                'history'      - return history structure for processing
                                 step of dataset
                'historymodel' - return history structure with field types
                                 as values
                                 short: 'hmodel'
                'historycheck' - check given structure for compliance with
                                 the toolbox history record structure
                                 short: 'hcheck'
 
    structure - struct
                either empty trEPR toolbox data structure or 
                trEPR toolbox data structure with field types as values
 
                In case of a history record, data structure complying with
                the history record data structure
 
    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.

Wie aus dem Hilfetext ersichtlich kann mit dieser Funktion eine Datenstruktur auf Konformität mit der Toolbox-Datenstruktur überprüft werden.

Spätere Versionen dieser Funktion haben evtl. dann auch die Fähigkeit, eine alte in die jeweils aktuelle Datenstruktur zu überführen.

de/software/matlab/trepr/dev/c/history.txt · Last modified: by 127.0.0.1