TCustomSpectrumAnalyzer Class

Header: Dew.Signal/SignalAnalysis.h · Cross-compiler
tObjectTMtxComponentTAnalysisTSpectrumTStaticSpectrumAnalyzerTCustomSpectrumAnalyzer

class TCustomSpectrumAnalyzer : public TStaticSpectrumAnalyzer;

Generic spectrum analyzer class.

The class is used as the basis for analyzing frequency spectrums.

Constructors

NameDescription
TCustomSpectrumAnalyzer (2)

Properties

NameTypeDescription
ActiveboolSet active to false to suppress the propagation of the Pull request and the subsequent call to the Update method.
AmpltTVec*Stores the amplitude of the spectrum.
AveragesintUsed to store the number of averages made.
BandsTSpectrumBandsAnalyzer*Holds the parameters for the frequency bands.
BandWidthdoubleReturns the bandwidth of the spectrum in [Hz].
BandwidthHdoubleReturns the upper bandwidth edge of the signal.
BandwidthLdoubleReturns the lower bandwidth edge of the signal.
BlockAssignboolBlock streaming of specific properties when storing only a "template".
ComplexboolSet this property to true, to request computation using complex numbers.
ConjExtendboolIf True, the conjugate symmetric part of the frequency spectrum is to be computed.
ConjFlipboolIf True, the conjugate symmetric part of the frequency spectrum will be placed in 0.5..1.0 Fs (as returned by the FFT), and not between -0.5..0.0 Fs.
ContinuousboolIf True, the component will pass on the udpate request to the connected component.
DescriptorTSpectrumDescriptor*
DtdoubleReturns the distance in seconds between two consecutive samples of the signal on which the frequency spectrum is based.
EditorActiveboolReturns True, if the component editor is displayed.
FloatPrecisionTMtxFloatPrecisionSet this property to request computation in 32bit/64bit precision with real/complex numbers.
FloatPrecisionLockboolSet this property to true to lock changes to FloatPrecision property.
HarmonicsintDefines number of harmonics to be used when calculating statistical parameters from the amplitude spectrum.
HzResdoubleReturns the frequency resolution in Hz.
InputTSignal*
InputsTSignalCollection*
IntegrationTIntegrationDefine the integration/differenation of the frequency spectrum.
IsDoubleboolSet this property to false, to request computation in 32bit floating point precision, 64bit, if true.
IsSpectrumAnalyzerboolReturns true, if the descendant class is derived from TSpectrumAnalyzer.
ItemNumberintNumber to label the object when it is an item in the List.
LdBSpandouble
LengthintDefines the length of the spectrum.
LogarithmicboolSet it to True, to obtain the logarithm of the spectrum in dB.
LogBasedoubleDefines the base of the logarithmic spectrum.
LogScaledoubleDefines the scaling of the logarithmic spectrum.
LogSpanTLogSpanDefines the span of the logarithmic spectrum in dB.
LogTypeTLogTypeSpecify how to apply the logarithm to the spectrum.
MainlobeWidthintDefines the width of the main lobe. Each frequency component in the frequency spectrum should theoretically be infinitely thin.
MarksTMarkList*Stores the frequency, amplitude and phase of selected frequency bins.
MaxAmpltdoubleStores the maximum value of the Amplt spectrum found by the MinMaxAmplt method.
MaxFreqIndexintHolds the index at which the maximum amplitude was found by the MinMaxAmplt method.
MaxPhasedoubleStores the maximum value of the Phase spectrum found by the MinMaxPhase method.
MinAmpltdoubleStores the minimum value of the Amplt spectrum found by the MinMaxAmplt method.
MinPhasedoubleStores the minimum value of the Phase spectrum found by the MinMaxPhase method.
MultiChannelboolSet MultiChannel to True, if Inputs property will be published, and Input property will remain hidden.
NameDewString
OnAfterUpdatetNotifyEventThe event is triggered after the call to the Update method.
OnBandsUpdatetNotifyEventIf assigned, this event will be called instead of a call to Bands.Update method.
OnBeforeUpdatetNotifyEventThe event is triggered just before the call to the Update method.
OnDisplayUpdatetNotifyEventThe event is triggered after the OnAfterUpdate event. Use this event to update any associated charts or graphs or result tables.
OnGetInputtNotifyEventIf the Input property is not assigned, the component will call OnGetInput.
OnNotifyUpdatetNotifyEventThe event is called after a call to InternalUpdate, OnAfterUpdate and OnDisplayUpdate from within the Update method.
OnParameterUpdatetNotifyEventThe event is triggered when ParamUpdate method is called. The ParamUpdate method is usually called by component editors when a value was changed by the user and the editor was "Live".
OnPeaksUpdatetNotifyEventIf assigned, this event will be called instead of a call to Peaks.Update method.
PeaksTSpectrumPeaksAnalyzer*Pointer to the component that manages peak analysis.
PhaseTVec*Stores the phase of the spectrum.
PhaseModeTPhaseModeThis property determines how to handle the phase of the frequency spectrum.
PhaseRangeTPhaseRangeSpecify the range of the phase spectrum.
PhaseUnitsTPhaseUnitsDefines the units of phase. (radian, degrees).
PipeDirtybool
PipeStateTPipeStateReturns the state of the pipe after the last update.
ReferenceTReferenceList*Stores a list of components that have to be notified, when this component is destroyed.
ReportTSpectrumReport*Holds the parameters needed to generate a spectrum analysis report. Requires that the descriptor property is properly filled up.
RotationintBefore the frequency analysis, the signal can be circularly rotated by a specified number of samples. Rotation defines the number of samples.
SamplingFrequencydoubleDefines the sampling frequency of the signal on which the frequency spectrum is based.
SamplingTimedoubleDefines the length of the signal on which the frequency spectrum is based in seconds.
ScaleFactordoubleFrequency spectrum will be scaled by a scale factor.
SpectrumTypeTSpectrumTypeSpecifies the spectrum type to be computed.
SuspendNotifyUpdateboolSet this property to True, to prevent calling OnNotifyUpdate from the Update Method.
UsesInputsboolSet it to True to indicate, that valid signals will be connected to the Input or Inputs properties.
ZeroPaddingintDefines the level of zero padding of the source signal.

Methods

NameDescription
AddAdd amplitude and phase of the ASpectrum to the current spectrum.
AllowStreamingReturns the negatated value of BlockAssign.
AmpltEst (4)Return amplitude at frequency Freq.
AmpltSpectrumCompute amplitude spectrum from X.
Assign
AssignTemplateAssign values of "template-like" published properties from Source.
BandFlipFlip the frequency spectrum on the frequency axis.
ConvergeToMaximum (2)Searches for the closest peaks of the amplitude spectrum.
CopyCopy ASpectrum to the calling spectrum.
DetectChannelCount
DifferentiateDifferentiate the underlying signal in the frequency domain by scaling each amplitude line with a power of its angular frequency.
DivideDivide the calling the spectrum with ASpectrum.
EditorClassTo be overriden in descendanr classses.
FilterPeakFilter the peak at Marks position Index from the signal and recalculate the spectrum.
FreqToFreqIndexComputes range checked array indexes in the spectrum from frequency values.
GetInput
GetInputs
InputsDirtyIf all Inputs[i] are dirty the function returns true.
IntegrateIntegrate the underlying signal in the frequency domain by dividing each amplitude line by a power of its angular frequency, restoring the DC term afterwards.
IntegrateSpectrum
InternalPullWhen called, the method will pass Update requests recursively to all connected objects.
InvalidateNotifies all connected components that this component has fresh data.
IsNumericalInterpolationSupported
LoadFromStreamLoad the component from Src stream.
LoadTemplateFromFileLoad a template from file.
LoadTemplateFromStreamLoad a template from stream.
LogAmpltCompute the logarithm of the amplitude spectrum and convert to dB.
MarksToStringsConvert marks to strings.
MinMaxCalls MinMaxAmplt and MinMaxPhase.
MinMaxAmpltFind minimum and maximum value of the Amplt spectrum.
MinMaxPhaseFind minimum and maximum value of the Phase spectrum.
MulMultiply the calling the spectrum with ASpectrum.
NFNoise floor in dB: the mean absolute noise line (lines outside the mark guard bands), relative to the largest marked peak.
ParamUpdateThe method can be assigned to some other component even handler, as a notification that a parameter has changed and that Self should consider a recalculation.
PeakApproximateReturn the peak closest to the Freq frequency.
PhaseEst (4)Return phase at frequency Freq.
PhaseSpectrumCompute phase spectrum from X.
PipeResetRecursively processes all connected components backward and calls Reset method.
PowerSpectrumCompute power spectrum from X.
PullRequest recalculation of the entire chain of all connected components.
PullUntilEndCalls Pull until pipeEnd is returned.
ReferenceRemoved
Reset
RMSRoot-mean-square value reconstructed from the amplitude spectrum.
RMSSpectrumCompute RMS spectrum from X.
SaveTemplateToFileSave template to file.
SaveTemplateToStreamSave template to stream.
SaveToStreamSave the component to Dst stream.
ScaleScale the calling spectrum with Factor.
SetComplex
SetFloatPrecision
SetInputs
SetIsDouble
SetZeroInitialize spectrum to zero.
SFDRSpurious-free dynamic range in dB: the ratio of the largest marked peak to the second-largest marked peak.
SINADSignal-to-noise-and-distortion ratio in dB. Compares the largest marked peak against the noise floor plus every other marked peak.
SizeAssign Length, Complex and SamplingFrequency properties.
SNRSignal-to-noise ratio in dB. Sums the absolute amplitudes of all marked peaks and compares against the sum of the absolute amplitude lines outside the mark guard bands.
SqrSquare the Amplt and Phase of the ASpectrum and copy it to self.
SubtractSubtract ASpectrum from the calling spectrum.
THDTotal harmonic distortion in percent. Returns the RMS of the marked harmonic peaks (all marks after the first, when sorted by frequency, up to Harmonics) relative to the first (fundamental) marked peak.
THDNTotal harmonic distortion plus noise, in percent. Combines the noise floor power with the power of every marked peak except the largest, relative to the largest marked peak.
UpdateRequest recalculation of the data and place the result in Self.
UpdateNotifyCall this method only, if SuspendNotifyUpdate is True.
ValuesToStringsConvert values to strings.

Fields

NameTypeDescription
Tagintptr_t