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:
- Um welches Modul handelt es sich?
- Was macht das Modul oder die Funktion?
- Wer sind die Autoren?
- Zu welcher Hochschule, Veranstaltung, Projekt gehört der Code?
- Bei Funktionen: Welche Eingangs- und Ausgangsparameter hat fie Funktion?
- Wann wurde die Datei erstellt und wann zuletzt geändert?
- Wird eine spezielle Toolbox verwendet?
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 2014 * % * %*********************************************************************/
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