FB_CMA_SparseSpectrum

Berechnung einzelner Spektralwerte für reell-wertige Eingangssignale

Der Baustein FB_CMA_SparseSpectrum liefert eine konfigurierbare Anzahl einzelner Spektralwerte, welche konform zu den Bausteinen FB_CMA_RealFFT, FB_CMA_MagnitudeSpectrum bzw. FB_CMA_PowerSpectrum skaliert sind. Die Berechnung der DFT Koeffizienten

FB_CMA_SparseSpectrum 1:

erfolgt mit dem Goertzel-Algorithmus. Dieser ist effizienter als eine radix-2 FFT, falls für die Anzahl M der zu berechnenden Koeffizienten bei einer Fensterlänge L gilt:

FB_CMA_SparseSpectrum 2:

Hierbei ist N die nächste größere Potenz von 2 bzgl. der Fensterlänge L. Werden nur wenige/einzelne Spektralwerte benötigt, können diese mit dem Funktionsbaustein ggf. direkt in der (schnellen) Sampling-Task berechnet werden, sodass auf spontane Veränderungen des Spektrums schneller reagiert werden kann.

Die höchste Frequenz einer Komponente im Eingangssignal sollte maximal bei der halben Abtastrate des Eingangssignals liegen, damit Aliasing-Effekte vermieden werden.

Der Baustein übernimmt mehrere Funktionen, siehe Analyse von Daten-Streams und Frequenzanalyse.

Der Eingabedatenpuffer wird zunächst mit den unmittelbar vorhergehenden Puffern überlappend kombiniert und mit einer Fensterfunktion multipliziert. Anschließend werden die DFT Koeffizienten über den Goertzel-Algorithmus berechnet. Über den Parameter eSpectrumType wird definiert ob von den resultierenden komplexen Werten der Absolutbetrag oder dessen Quadrat berechnet werden. Wenn der Parameter bTransformToDecibel den Wert TRUE hat werden die Werte zu Dezibel -Werten transformiert, falls Magnituden- oder Leistungswerte berechnet wurden. Diese Dezibel-Werte sind für beide Spektralwerte gleich, d.h. der Einfluss der Quadrierung bei den Leistungswerten wird bei der Berechnung der Dezibel-Werte durch einen Faktor zwei für die Magnitudenwerte berücksichtigt. Des Weiteren ist eine Skalierung der Ergebnisse über den Parameter eScalingType durchführbar, siehe dazu Skalierung von Spektren.

Skalierung

Die Skalierung der erhaltenen Ergebniswerte, also z. B. der Beschleunigungsdichten (Acceleration Spectral Densities) entspricht standardmäßig der Definition der FFT. Dies bedeutet, dass der Einfluss der Fensterlänge und der Fensterfunktion herausgerechnet werden.
Zur rechnerischen Skalierung absoluter Messungen können tabellierte Parameter verwendet werden, die im Abschnitt "Optionen der Spektrumsskalierung“ beschrieben sind.

Gedächtniseigenschaften

Aufgrund der Verwendung der Welch-Methode wird jeweils der aktuelle Eingangsdatenpuffer zusammen mit den zuletzt übergebenen Puffern zur Berechnung genutzt. Die Anzahl der einfließenden Puffer ist abhängig von der gewählten Überlappung (nOverlap).
Die Frequenzanalyse berücksichtigt Sprünge in der Zeitreihe. Um ein korrektes Ergebnis zu erzielen, müssen sich deswegen die verwendeten Eingangsdatenpuffer lückenlos und ohne Sprünge aneinanderreihen.

NaN Vorkommnis

Falls der Eingangsvektor einen oder mehrere NaN (Not a Number)-Werte beinhaltet, wird der gesamte Ausgangsvektor mit NaN gefüllt. Siehe separates Kapitel für weitere Information über NaN Werte.

FB_CMA_SparseSpectrum 3:

Behandlung von NaN-Werten

Falls die oben beschriebenen Situationen, welche zu NaN-Werten führen, nicht ausgeschlossen oder sicher vernachlässigt werden können, muss das Anwendungsprogramm diese Fehlerwerte behandeln.

Verhalten bei der Verarbeitung mehrkanaliger Eingangsdaten

Bei der Verarbeitung mehrerer Kanäle (nChannels > 1) besteht die Möglichkeit unterschiedlicher Rückgabewerte je Kanal. In diesem Fall können gesonderte Rückgabewerte am Funktionsbaustein abgefragt werden. Sind die Ergebnisse von einem oder mehreren Kanälen unzulässig, jedoch nicht alle Kanäle, dann entspricht der Wert am Baustein eCM_InfRTime_AmbiguousChannelResults. Sind die Ergebnisse aller Kanäle unzulässig, dann entspricht der Wert am Baustein eCM_ErrRTime_ErrornousChannelResults.

Die Abfrage einer Liste der Rückgabewerte aller Kanäle kann über die Methode GetChannelErrors()erfolgen.

Bespielimplementierung

Eine beispielhafte Implementierung, welche die Verwendungsmöglichkeiten des Bausteins und dessen Konfiguration zeigt, ist unter folgendem Link verfügbar: Berechnung einzelner Spektralwerte

Ein- und Ausgänge

Die Ein- und Ausgangspuffer entsprechen einer der folgenden Definitionen (input / output shape). Die variablen Parameter sind Teil des Bausteineingangs stInitPars.

Varianten

Eingangspuffer (MultiArray input stream)
Elementtyp, Dimensionsanzahl, Dimensionsgrößen

Ausgangspuffer (MultiArray output stream)
Elementtyp, Dimensionsanzahl, Dimensionsgrößen

Standardvariante DFT
(nChannels = 1, eSpectrumType = eCM_DFT)

LREAL, 1,
nWindowLength-nOverlap

LCOMPLEX, 1,
nBins

Standardvariante Spektrum
(nChannels = 1, eSpectrumType <> eCM_DFT)

LREAL, 1,
nWindowLength-nOverlap

LREAL, 1,
nBins

Mehrkanalige Variante DFT
(nChannels > 1, eSpectrumType = eCM_DFT)

LREAL, 2,
nChannels x nWindowLength-nOverlap

LCOMPLEX, 2,
nChannels x nBins

Mehrkanalige Variante Spektrum
(nChannels > 1, eSpectrumType <> eCM_DFT)

LREAL, 2,
nChannels x nWindowLength-nOverlap

LREAL, 2,
nChannels x nBins

Eingangsparameter

Die Eingangsparameter dieses Bausteins repräsentieren Initialisierungsparameter und müssen bereits bei der Deklaration der FB Instanz zugewiesen werden! (Alternativ: Init()-Methode). Sie dürfen nur einmalig zugewiesen werden. Eine Änderung zur Laufzeit ist nicht möglich.

VAR_INPUT
    stInitPars       : ST_CM_SparseSpectrum_InitPars;     // init parameter
    nOwnID           : UDINT;                             // ID for this FB instance
    aDestIDs         : ARRAY[1..cCMA_MaxDest] OF UDINT;   // IDs of destinations for output
    nResultBuffers   : UDINT := 4;                        // number of MultiArrays which should be initialized for results (0 for no initialization)
    tTransferTimeout : LTIME := LTIME#500US;              // timeout checking off during access to inter-task FIFOs
END_VAR

Ausgangsparameter

VAR_OUTPUT
    bError         : BOOL;                           // TRUE if an error occurs. Reset by next method call.
    hrErrorCode    : HRESULT;                        // '< 0' = error; '> 0' = info; '0' = no error/info
    ipErrorMessage : I_TcMessage := fbErrorMessage;  // Shows detailed information about occurred errors, warnings and more.
    nCntResults    : ULINT;                          // Counts outgoing results (MultiArrays were calculated and sent to transfer tray).
END_VAR
  • bError: Der Ausgang ist TRUE, falls ein Fehler auftritt.
  • hrErrorCode: Falls ein Fehler auftritt, wird ein entsprechender Fehlercode vom Typ HRESULT ausgegeben. Mögliche Werte sind in der Liste der Fehlercodes erläutert.
  • ipErrorMessage: Beinhaltet nähere Informationen zum aktuellen Rückgabewert. Siehe hierzu den Abschnitt Fehlerbeschreibung und Information. Für diesen speziellen Schnittstellenzeiger ist intern sichergestellt, dass er immer gültig/zugewiesen ist.

Methoden

Call():

Die Methode wird jeden Zyklus aufgerufen, um den Algorithmus auf die aktuellen Eingangsdaten anzuwenden. Der Baustein wartet auf Eingangsdaten, sofern die Methode weder neue Ergebnisse noch einen Fehler angibt. Dies ist ein reguläres Verhalten im Ablauf der Analysekette.

  • Rückgabewert: Falls ein Fehler auftritt, wird ein entsprechender Fehlercode vom Typ HRESULT ausgegeben. Mögliche Werte sind in der Liste der Fehlercodes erläutert.
METHOD Call : HRESULT
VAR_OUTPUT
    bNewResult   : BOOL;       // TRUE every time when outgoing MultiArray was calculated and sent to transfer tray.
    bError       : BOOL;       // TRUE if an error occurs.
    hrErrorCode  : HRESULT;    // '< 0' = error; '> 0' = info; '0' = no error/info
END_VAR
  • bError: Der Ausgang ist TRUE, falls ein Fehler auftritt.
  • hrErrorCode: Falls ein Fehler auftritt, wird ein entsprechender Fehlercode vom Typ HRESULT ausgegeben. Mögliche Werte sind in der Liste der Fehlercodes erläutert. Dieser Ausgang ist identisch zum Rückgabewert der Methode.
FB_CMA_SparseSpectrum 4:

Falls ein Timeout eintritt oder kein MultiArray Puffer für das Ergebnis verfügbar ist, so gehen weder die Eingangsdaten noch die Ergebnisdaten verloren. Sie werden beim nächsten Aufruf weitergeleitet.

Configure():

Mit dem Aufruf dieser Methode müssen die Spektralwerte zu Beginn konfiguriert werden. Hierbei berechnet sich der DFT Index zur Frequenz f zu k = f * fSampleRate / nWindowLength. Ist f kein ganzzahliges Vielfaches der Frequenzauflösung fSampleRate / nWindowLength sind die Spektralanteile auf zwei aufeinander folgende Spektralwerte aufgeteilt.

Das entsprechende SPS Array muss wie folgt definiert sein. Für eine erneute Konfiguration mit einem anderen Satz an Argumenten kann die Configure() Methode ebenfalls genutzt werden.

METHOD Configure : HRESULT
VAR_INPUT
    pArg     : PVOID;    // pointer to array of arguments
    nArgSize : UDINT;    // size of arguments buffer in bytes 
END_VAR

Die Eingangspuffer entsprechen einer der folgenden Definitionen (input shape). Die variablen Parameter sind Teil des Bausteineingangs stInitPars.

Varianten

Eingangspuffer (MultiArray input stream)
Elementtyp, Dimensionsanzahl, Dimensionsgrößen

Identische Konfiguration aller Kanäle

UDINT, 1,
nBins

Kanalspezifische Konfiguration
(nChannels > 1)

UDINT, 2,
nChannels x nBins

Init():

Üblicherweise ist diese Methode in einer Condition Monitoring Applikation nicht notwendig. Sie bietet eine Alternative zur Bausteininitialisierung. Die Init() Methode darf nur während der Initialisierungsphase der SPS aufgerufen werden. Sie kann nicht während der Laufzeit verwendet werden. Es sei auf die Verwendung von einer FB_init Methode oder dem Attribut 'call_after_init' hingewiesen (siehe TwinCAT SPS Referenz). Hiermit wird zudem die Bausteinkapselung erleichtert.

Die Eingangsparameter der Bausteininstanz dürfen nicht bei der Deklaration zugewiesen werden, falls die Initialisierung mit der Init() Methode erfolgen soll.

  • Rückgabewert: Falls ein Fehler auftritt, wird ein entsprechender Fehlercode vom Typ HRESULT ausgegeben. Mögliche Werte sind in der Liste der Fehlercodes erläutert.
METHOD Init : HRESULT
VAR_INPUT
    stInitPars     : ST_CM_SparseSpectrum_InitPars;    // init parameter
    nOwnID         : UDINT;                            // ID for this FB instance
    aDestIDs       : ARRAY[1..cCMA_MaxDest] OF UDINT;  // IDs of destinations for output
    nResultBuffers : UDINT := 4;                       // number of MultiArrays which should be initialized for results (0 for no initialization)
END_VAR

ResetData():

Die Methode löscht alle bereits hinzugefügten Datensätze, vgl. Gedächtniseigenschaft des Funktionsbausteins. Wird nach einem ResetData() die Call()-Methode wieder aufgerufen, muss entsprechend erst der interne Speicher wieder aufgefüllt werden um ein gültiges Ergebnis zu berechnen.

  • Rückgabewert: Falls ein Fehler auftritt, wird ein entsprechender Fehlercode vom Typ HRESULT ausgegeben. Mögliche Werte sind in der Liste der Fehlercodes erläutert.
METHOD ResetData : HRESULT
VAR_INPUT
END_VAR

PassInputs():

Solange eine FB_CMA_Source Instanz aufgerufen wird und somit Signaldaten zu einem Zielblock übertragen werden, müssen wie in der API SPS Referenz erläutert alle weiteren Blöcke der Analysekette zyklisch aufgerufen werden.
Manchmal ist es sinnvoll, einen Algorithmus für eine bestimmte Zeit nicht auszuführen. Beispielsweise sollten manche Algorithmen nur nach vorherigem Training bzw. Konfiguration ausgeführt werden. Zwar muss der Funktionsbaustein dennoch zyklisch aufgerufen werden, aber es ist ausreichend, wenn die am Baustein ankommenden Daten im Kommunikationsring weitergeleitet werden. Dies geschieht mittels der Methode PassInputs() anstelle der Methode Call(). Hierbei wird der Algorithmus selbst nicht aufgerufen und entsprechend kein Ergebnis berechnet sowie kein Ausgangspuffer generiert.

  • Rückgabewert: Falls ein Fehler auftritt, wird ein entsprechender Fehlercode vom Typ HRESULT ausgegeben. Mögliche Werte sind in der Liste der Fehlercodes erläutert.
METHOD PassInputs : HRESULT
VAR_INPUT
END_VAR

GetChannelErrors():

Die Methode ermöglicht die Abfrage einer Liste der kanalspezifischen Rückgabewerte bei der Verarbeitung mehrerer Kanäle (nChannels > 1). Ein Aufruf ist sinnvoll für den Fall, dass der Rückgabewert des Bausteins einem der Werte eCM_InfRTime_AmbiguousChannelResults oder eCM_ErrRTime_ErrornousChannelResults entspricht.

  • Rückgabewert: Information über den Ausleseprozess der Liste der Fehlercodes. Der Wert wird auf TRUE gesetzt, falls die Abfrage erfolgreich war, FALSE anderenfalls.

    METHOD GetChannelErrors : BOOL
VAR_IN_OUT
    aChannelErrors : ARRAY[*] OF HRESULT;
END_VAR
  • aChannelErrors: Fehlerliste vom Typ HRESULT der Länge nChannels.

Ähnliche Funktionsbausteine

Der Baustein FB_CMA_RealFFT berechnet die schnelle Fouriertransformation für reell-wertige Eingangssignale.

Der Baustein FB_CMA_MagnitudeSpectrum berechnet das Magnitudenspektrum eines reell-wertigen Eingangssignals.

Der Baustein FB_CMA_PowerSpectrum berechnet das Leistungsspektrum mit einer Quadrierung der Werte im letzten Schritt.

Voraussetzungen

Entwicklungsumgebung

Zielplattform

Einzubindende SPS-Bibliotheken

TwinCAT v3.1.4022.25

PC or CX (x86, x64)

Tc3_CM, Tc3_CM_Base