Header Beispiel für MATLAB
Autor: Prof. Ulrich Schneider
Lektion 1: MATLAB® Getting Started
Header
Verwenden Sie in jeder Datei einen Header, der die nachfolgenden Fragen beantwortet:
| Bezeichnung | Bedeutung |
|---|---|
| Modul | Um welches Modul handelt es sich? |
| Funktion | Was macht das Modul? Beschreiben Sie die Funktion. |
| Implementation | MATLAB Revision, auf der Sie das Modul getestet haben. |
| Toolbox | Ist eine Toolbox zur Ausführung notwendig? |
| Author | Wer sind die Autoren? |
| Bemerkung | Zu welcher Hochschule, Veranstaltung, Projekt gehört der Code? Sind zum Ausführen Dateien notwendig? Bei Funktionen: Welche Eingangs- und Ausgangsparameter hat die Funktion? |
| Letzte Änderung | Wann wurde die Datei zuletzt geändert? |
Vorlage
%**************************************************************************
% Hochschule Hamm-Lippstadt *
%**************************************************************************
% Modul : *
% *
% Datum : *
% *
% Funktion : *
% *
% Implementation : *
% *
% Toolbox : *
% *
% Author : *
% *
% Bemerkung : *
% *
% Letzte Änderung : *
% *
%**************************************************************************
Beispiel
%**************************************************************************
% Hochschule Hamm-Lippstadt *
%**************************************************************************
% Modul : entferneMoireMuster.m *
% *
% Datum : 16. Mai 2014 *
% *
% Funktion : Moire Muster wird im im Frequenzbereich entfernt *
% *
% Implementation : MATLAB R2013a *
% *
% Toolbox : Camera Calibration Toolbox *
% *
% Author : Prof. Schneider *
% *
% Bemerkung : basierend auf der *
% Camera Calibration Toolbox for Matlab *
% http://www.vision.caltech.edu/bouguetj/calib_doc/ *
% *
% Letzte Änderung : 03. Januar 2015 *
% *
%**************************************************************************
MATLAB® Hilfe
Jede Funktion sollte eine MATLAB® Hilfe bekommen, die erläutert, wie die Funktion aufzurufen ist. Die Hilfe wird vor den Header geschrieben und vom Header mit einer Freizeile getrennt.
Sie läßt sich mit
>> help <Funktionsaufruf>
anzeigen.
Beispiel
>> help ZeigeMesswerte
% Diese MATLAB-Funktion stellt die Messdaten für den Zyklus nFrame dar.
%
% SYNTAX:
% ZeigeMesswerte(hMesswerte, nFrame, z)
%
% BESCHREIBUNG:
% Mit dem Aufruf werden die Daten in ein Bild eingezeichnet.
%
% Eingabewerte sind:
% hMesswerte: Handle zum den Messwerten
% nFrame: Aktuelle Framenummer (z.B. 10)
% z: Messvektor für den Zyklus nFrame (2x682 double)
%
% Ein Rückgabewert existiert nicht.
%
% BEISPIEL:
% ZeigeMesswerte(hMesswerte, 10, z)
%****************************************************************
% Hochschule Hamm-Lippstadt *
%****************************************************************
% Modul : ZeigeMesswerte.m *
% *
% Datum : 16. Mai 2014 *
% *
% Funktion : Aktualisierung der Messwerte in einem Plot *
% *
% Implementation : MATLAB R2020b *
% *
% Toolbox : - *
% *
% Author : Prof. Schneider *
% *
% Bemerkung : Projekt: Darstellung der LiDAR Daten *
% *
% Aufgerufen von : startDarstellungDerMessdaten.m *
% *
% Letzte Änderung : 27. August 2021 *
% *
%***************************************************************/
function ZeigeMesswerte(hMesswerte, nFrame, z)
title(['Frame: ',num2str(nFrame)]) % Framenummer im Titel aktualisieren
set(hMesswerte,'XData',z(2,:),'YData',z(1,:)) % Messwerte aktualisieren
end