sbgEComVibMonFft.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_VIB_MON_FFT_H
#define SBG_ECOM_VIB_MON_FFT_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
 
// Project headers
#include <logs/sbgEComLogVibMon.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Constant definitions                                               -//
//----------------------------------------------------------------------//

#define SBG_ECOM_VIB_MON_FFT_MAX_BIN_COUNT                  (2048)
 
//----------------------------------------------------------------------//
//- Structure definitions                                              -//
//----------------------------------------------------------------------//

typedef struct _SbgEComVibMonFft
{
    uint32_t                         timestampUs;                                    
    uint16_t                         status;                                      
    uint16_t                         fSampling;                                        
    uint16_t                         binCount;                                      
    float                            scaleFactor;                                    
    float                            offset;                                      
    float                            acf;                                            
    float                            ecf;                                            
    uint16_t                         buffer[SBG_ECOM_VIB_MON_FFT_MAX_BIN_COUNT];    
} SbgEComVibMonFft;
 
//----------------------------------------------------------------------//
//- Public functions (SbgEComVibMonFft)                                -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComVibMonFftReadFromStream(SbgEComVibMonFft *pVibMonFft, SbgStreamBuffer *pStreamBuffer);

SbgErrorCode sbgEComVibMonFftWriteToStream(const SbgEComVibMonFft *pVibMonFft, SbgStreamBuffer *pStreamBuffer);
 
//----------------------------------------------------------------------//
//- Public setters/getters                                             -//
//----------------------------------------------------------------------//

SbgEComVibMonAxis sbgEComVibMonFftGetAxis(const SbgEComVibMonFft *pLogData);

SbgEComVibMonWindow sbgEComVibMonFftGetWindow(const SbgEComVibMonFft *pLogData);

float sbgEComVibMonFftGetFrequencyFromBinIndex(const SbgEComVibMonFft *pVibMonFft, size_t binIndex);

size_t sbgEComVibMonFftGetBinIndexFromFrequency(const SbgEComVibMonFft *pVibMonFft, float frequency);

float sbgEComVibMonFftGetMagnitudeFromBinIndex(const SbgEComVibMonFft *pVibMonFft, size_t binIndex);

float sbgEComVibMonFftGetMagnitudeFromBinIndexAcfCorrected(const SbgEComVibMonFft *pVibMonFft, size_t binIndex);

float sbgEComVibMonFftGetMagnitudeFromBinIndexEcfCorrected(const SbgEComVibMonFft *pVibMonFft, size_t binIndex);

float sbgEComVibMonFftGetMagnitudeFromFrequency(const SbgEComVibMonFft *pVibMonFft, float frequency);

float sbgEComVibMonFftGetMagnitudeFromFrequencyAcfCorrected(const SbgEComVibMonFft *pVibMonFft, float frequency);

float sbgEComVibMonFftGetMagnitudeFromFrequencyEcfCorrected(const SbgEComVibMonFft *pVibMonFft, float frequency);
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_VIB_MON_FFT_H