Header Beispiel für MATLAB: Unterschied zwischen den Versionen

Aus HSHL Mechatronik
Zur Navigation springen Zur Suche springen
 
(12 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 4: Zeile 4:




= Lektion 1: Matlab Getting Started =
= Lektion 1: MATLAB<sup>®</sup> Getting Started =
== Header ==
== Header ==
Verwenden Sie in jeder Datei einen Header, der die nachfolgenden Fragen beantwortet:
Verwenden Sie in jeder Datei einen Header, der die nachfolgenden Fragen beantwortet:
* Um welches Modul handelt es sich?
{| class="wikitable"
* Was macht das Modul oder die Funktion?
|-
* Wer sind die Autoren?
! Bezeichnung !! Bedeutung
* Zu welcher Hochschule, Veranstaltung, Projekt gehört der Code?
|-
* Bei Funktionen: Welche Eingangs- und Ausgangsparameter hat fie Funktion?
| Modul || Um welches Modul handelt es sich? Wie heißt Ihre Datei?
* Wann wurde die Datei erstellt und wann zuletzt geändert?
|-
* Wird eine spezielle Toolbox verwendet?
| 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 ==
<source line lang="matlab" style="font-size:medium">%**************************************************************************
%                  Hochschule Hamm-Lippstadt                            *
%**************************************************************************
% Modul           :                                                      *
%                                                                        *
% Datum          :                                                      *
%                                                                        *
% Funktion        :                                                      *
%                                                                        *
% Implementation  :                                                      *
%                                                                        *
% Toolbox        :                                                      *
%                                                                        *
% Author          :                                                      *
%                                                                        *
% Bemerkung      :                                                      *
%                                                                        *
% Letzte Änderung :                                                      *
%                                                                        *
%**************************************************************************
</source>
=== Beispiel ===
=== Beispiel ===


<pre>
<source line lang="matlab" style="font-size:medium">%**************************************************************************
%**********************************************************************
%        Hochschule Hamm-Lippstadt                                       *
%        Hochschule Hamm-Lippstadt                                   *
%**************************************************************************
%**********************************************************************
% Modul           : entferneMoireMuster.m                                *
% Modul           : ML_5_2b                                          *
%                                                                         *
%                                                                     *
% Datum          : 16. Mai 2014                                         *
% Datum          : 16-Mai-2014                                       *
%                                                                         *
%                                                                     *
% Funktion        : Moire Muster wird im im Frequenzbereich entfernt     *
% Funktion        : Moire Muster im Frequenzbereich entfernt         *
%                                                                         *
%                                                                     *
% Implementation  : MATLAB R2013a                                         *
% Implementation  : MATLAB R2013a                                     *
%                                                                         *
%                                                                     *
% Toolbox        : Camera Calibration Toolbox                           *
% Toolbox        : Camera Calibration Toolbox                       *
%                                                                         *
%                                                                     *
% Author          : Prof. Schneider                                       *
% Author          : Prof. Schneider                                   *
%                                                                         *
%                                                                     *
% Bemerkung      : basierend auf der                                     *
% Bemerkung      : basierend auf der                                 *
%                  Camera Calibration Toolbox for Matlab                 *
%                  Camera Calibration Toolbox for Matlab             *
%                  http://www.vision.caltech.edu/bouguetj/calib_doc/     *
%                  http://www.vision.caltech.edu/bouguetj/calib_doc/ *
%                                                                         *
%                                                                     *
% Letzte Änderung : 03. Januar 2015                                      *
% Letzte Änderung : 03. Januar 2014                                  *
%                                                                         *
%                                                                     *
%**************************************************************************
%*********************************************************************/
</source>
</pre>


== MATLAB&#174; Hilfe ==
== MATLAB<sup>®</sup> Hilfe ==
Jede Funktion sollte eine MATLAB&#174; Hilfe bekommen, die erläutert, wie die Funktion aufzurufen ist.
Jede Funktion sollte eine MATLAB<sup>®</sup> Hilfe bekommen, die erläutert, wie die Funktion aufzurufen ist.
Die Hilfe wird vor den Header geschrieben und vom Header mit einer Freizeile getrennt.
Die Hilfe wird vor den Header geschrieben und vom Header mit einer Freizeile getrennt.


Zeile 51: Zeile 83:
</pre>
</pre>
anzeigen.
anzeigen.
'''Beispiel:'''
 
=== Beispiel ===
<pre>
<pre>
>> help ZeigeMesswerte
>> help ZeigeMesswerte
</pre>
</pre>


=== Beispiel ===
<pre>
<pre>
%  Diese MATLAB-Funktion stellt die Messdaten für den Zyklus nFrame dar.
%  Diese MATLAB-Funktion stellt die Messdaten für den Zyklus nFrame dar.
Zeile 82: Zeile 113:
% Modul           : ZeigeMesswerte.m                            *
% Modul           : ZeigeMesswerte.m                            *
%                                                              *
%                                                              *
% Datum          : 16-Mai-2014                                 *
% Datum          : 16. Mai 2014                               *
%                                                              *
%                                                              *
% Funktion        : Aktualisierung der Messwerte in einem Plot  *
% Funktion        : Aktualisierung der Messwerte in einem Plot  *
Zeile 93: Zeile 124:
%                                                              *
%                                                              *
% Bemerkung      : Projekt: Darstellung der LiDAR Daten        *
% Bemerkung      : Projekt: Darstellung der LiDAR Daten        *
%
%                                                               *
% Aufgerufen von  : startDarstellungDerMessdaten.m
% Aufgerufen von  : startDarstellungDerMessdaten.m             *
%                                                              *
%                                                              *
% Letzte Änderung : 27. August 2021                            *
% Letzte Änderung : 27. August 2021                            *

Aktuelle Version vom 15. Juli 2024, 18:12 Uhr

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? Wie heißt Ihre Datei?
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
Abgerufen von „https://wiki.hshl.de/wiki/index.php?title=Header_Beispiel_für_MATLAB&oldid=122210“