ICF 3.0.5.47
Technical documentation of ICF Libraries
imeas::CCrossCorrelationProcessorComp Class Reference

Implementation of a processor for calculation of cross correlation between two data sequence objects. More...

#include <CCrossCorrelationProcessorComp.h>

Inheritance diagram for imeas::CCrossCorrelationProcessorComp:
Collaboration diagram for imeas::CCrossCorrelationProcessorComp:

Public Types

typedef iproc::TSyncProcessorCompBase< IDataSequenceCorrelationProcessorBaseClass
 
- Public Types inherited from iproc::TSyncProcessorCompBase< IDataSequenceCorrelationProcessor >
typedef ilog::CLoggerComponentBase BaseClass
 
typedef iproc::TSyncProcessorWrap< IDataSequenceCorrelationProcessor > BaseClass2
 
typedef IDataSequenceCorrelationProcessor InterfaceType
 
- Public Types inherited from ilog::TLoggerCompWrap< Base >
enum  MessageId { MI_BAD_DEPENDENCY = 0x8a340 }
 
typedef Base BaseClass
 
typedef ilog::CLoggerBase BaseClass2
 
- Public Types inherited from iproc::TSyncProcessorWrap< IDataSequenceCorrelationProcessor >
typedef IDataSequenceCorrelationProcessor BaseClass
 

Public Member Functions

virtual bool CalculateCorrelation (const imeas::IDataSequence &input1, const imeas::IDataSequence &input2, imeas::IDataSequence &correlation) const override
 
virtual iproc::CTaskState DoProcessing (const iprm::IParamsSet *paramsPtr, const istd::IPolymorphic *inputPtr, istd::IChangeable *outputPtr, bool allowAsync=false, iproc::IProgressManager *progressManagerPtr=nullptr) override
 
- Public Member Functions inherited from ilog::CLoggerBase
 CLoggerBase ()
 
const QByteArray & GetVerboseSenderId () const
 Get sender ID for verbose messages.
 
void SetVerboseSenderId (const QByteArray &id)
 Set sender ID for verbose messages.
 
void SetLogPtr (ilog::IMessageConsumer *logPtr) override
 Install log.
 
ilog::IMessageConsumerGetLogPtr () const override
 Get log.
 
- Public Member Functions inherited from ilog::ILoggable
- Public Member Functions inherited from iproc::TSyncProcessorWrap< IDataSequenceCorrelationProcessor >
 TSyncProcessorWrap ()
 
int GetProcessorState (const iprm::IParamsSet *paramsPtr) const override
 
bool AreParamsAccepted (const iprm::IParamsSet *paramsPtr, const istd::IPolymorphic *inputPtr, const istd::IChangeable *outputPtr) const override
 
void InitProcessor (const iprm::IParamsSet *paramsPtr, bool doReset) override
 

Static Protected Member Functions

static double GetSampleAverage (const imeas::IDataSequence &input, int channelIndex)
 Calculate mean sample value for a given channel.
 

Additional Inherited Members

- Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
virtual void DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
 Decorate message parts before outputting.
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from ilog::CLoggerBase
bool IsVerboseEnabled () const
 Check if verbose messages are enabled.
 
bool SendVerboseMessage (const QString &message, const QString &messageSource=QString()) const
 Send verbose message.
 
bool SendInfoMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send info message to log.
 
bool SendWarningMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send warning message to log.
 
bool SendErrorMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send error message to log.
 
bool SendCriticalMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send critical message to log.
 
bool SendInfoMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once info message to log.
 
bool SendWarningMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once warning message to log.
 
bool SendErrorMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once error message to log.
 
bool SendCriticalMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once critical message to log.
 
bool SendUserMessage (const istd::IInformationProvider *messagePtr) const
 Send message with user object.
 
bool AllowMessageOnceAgain (int id)
 Reset message lock.
 
bool IsLogConsumed (const istd::IInformationProvider::InformationCategory *categoryPtr=nullptr, const int *flagsPtr=nullptr) const override
 Check if any log message is consumed.
 
bool SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const override
 Send any message to log.
 
- Protected Member Functions inherited from istd::ILogger
- Protected Attributes inherited from ilog::CLoggerBase
QSet< int > m_onceMessageIds
 

Detailed Description

Implementation of a processor for calculation of cross correlation between two data sequence objects.

Definition at line 22 of file CCrossCorrelationProcessorComp.h.

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ CalculateCorrelation()

virtual bool imeas::CCrossCorrelationProcessorComp::CalculateCorrelation ( const imeas::IDataSequence & input1,
const imeas::IDataSequence & input2,
imeas::IDataSequence & correlation ) const
overridevirtual

◆ DoProcessing()

virtual iproc::CTaskState imeas::CCrossCorrelationProcessorComp::DoProcessing ( const iprm::IParamsSet * paramsPtr,
const istd::IPolymorphic * inputPtr,
istd::IChangeable * outputPtr,
bool allowAsync = false,
iproc::IProgressManager * progressManagerPtr = nullptr )
overridevirtual

◆ GetSampleAverage()

static double imeas::CCrossCorrelationProcessorComp::GetSampleAverage ( const imeas::IDataSequence & input,
int channelIndex )
staticprotected

Calculate mean sample value for a given channel.


The documentation for this class was generated from the following file:

© Witold Gantzke and Kirill Lepskiy