TSignalBuffer Class

Header: Dew.Signal/SignalProcessing.h · Cross-compiler
tObjectTMtxComponentTAnalysisTSignalTSignalBuffer

class TSignalBuffer : public TSignal;

Keeps signal processing data pipe synchronized.

Use the component to synchronize data processing pipe, where you need a large input buffer to perform filtering or a large scrolling buffer for signal analysis. The output data length is specified with the value of the Length property. This value may be bigger or smaller then the value of Input.Length property. The size of the buffer must be at least Max(Input.Length,Length). The size of the buffer can also be set automatically by the component, if you set AutoBufferSize to True.

Constructors

NameDescription
TSignalBuffer (2)

Destructors

NameDescription
~TSignalBuffer

Properties

NameTypeDescription
ActiveboolSet active to false to suppress the propagation of the Pull request and the subsequent call to the Update method.
BandWidthdoubleReturn the bandwidth of the signal.
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".
BufferSizeLimitintLimits the maximum buffer size, if AutoBufferSize is True.
BufferTypeTBufferTypeDefines the type of the buffer.
ChannelCountintGet or set the number of channels multiplexed in the data property.
ComplexboolSet this property to true, to request computation using complex numbers.
ContinuousboolIf True, the component will pass on the udpate request to the connected component.
DataTVec*Stores the result of the processing.
DtdoubleTime between two consecutive samples.
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.
HzResdoubleFrequency resolution obtained, if an FFT algorithm would be run on the data.
IncrementStepdoubleDefines the minimum factor by which the buffer size will be increased.
InputTSignal*
InputsTSignalCollection*
IsDoubleboolSet this property to false, to request computation in 32bit floating point precision, 64bit, if true.
ItemNumberintNumber to label the object when it is an item in the List.
LengthintGet or set the length of the signal in samples.
MarksTMarkList*Stores the time stamps and amplitude of selected samples.
MaxAmpltdoubleStores the maximum amplitude of the signal found by the MinMax method.
MaxXdoubleUse the MaxX property to store the time stamp (in seconds) of the right most sample.
MinAmpltdoubleStores the minimum amplitude of the signal found by the MinMax method.
MinXdoubleUse the MinX property to store the time stamp of the left-most sample.
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.
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".
OverlappingdoubleOverlapping defines the percent of previously read data to be read again.
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.
SamplingFrequencydoubleDefines the sampling frequency of the signal.
SamplingTimedoubleThe length of the signal in seconds.
StrideLengthintStrideLength defines the number of samples that will be skipped between consecutive reads from the buffer.
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.

Methods

NameDescription
AllowStreaming
AppendAppends Sample to the end of the signal.
Assign
AssignTemplateAssign values of "template-like" published properties from Source.
BufferedSamplesCountReturns the number of samples currently stored in the buffer.
BufferLengthDefines the length of the internal buffer in samples.
BufferOverrunReturns True, if the internal buffer has been overrun.
BufferReadPositionReturns the current circular buffer read position.
BufferUnderrunReturns True, if the internal buffer has been underrun.
BufferWritePositionReturns the current circular buffer write position.
CopyCopies signal Data and sampling frequency information.
CrestCompute the CREST parameter.
DataInBufferReturns true, if there is enough data in buffer to fill Data.Length.
DetectChannelCount
EditorClassTo be overriden in descendanr classses.
get_CValues
get_Values
GetInput
GetInputs
InputsDirtyIf all Inputs[i] are dirty the function returns true.
InternalPull
InvalidateNotifies all connected components that this component has fresh data.
LoadFromStreamLoad the component from Src stream.
LoadTemplateFromFileLoad a template from file.
LoadTemplateFromStreamLoad a template from stream.
MarksToStringsConvert marks to strings.
MinMaxFind minimum and maximum amplitude and store the result in the MinAmplt and MaxAmplt properties.
MonitorReads Dst.Length of most recent data, without advancing the read or write cursor.
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.
PeakFind the maximum deviation of the signal from its mean value.
PipeResetRecursively processes all connected components backward and calls Reset method.
PullRequest recalculation of the entire chain of all connected components.
PullUntilEndCalls Pull until pipeEnd is returned.
ReadReads data from internal Buffer to the Data property.
ReadReminderReads any data still in the buffer, but less than specified Length. Missing samples become zeros.
ReferenceRemoved
Reset (2)Reset the buffer.
SaveTemplateToFileSave template to file.
SaveTemplateToStreamSave template to stream.
SaveToStreamSave the component to Dst stream.
set_CValues
set_Values
SetComplex
SetFloatPrecision
SetInputs
SetIsDouble
SizeAssign the size of the signal from Src.
UpdateRequest recalculation of the data and place the result in Self.
UpdateNotifyCall this method only, if SuspendNotifyUpdate is True.
Values
ValuesToStringsConvert values to strings.
Write (2)Writes data to the buffer and resizes the buffer, if it is not big enough to hold everything.
WriteToWrites data to the buffer and resizes the buffer, if it is not big enough to hold everything. Converts precision single/double if needed.

Operators

NameDescription
operator[]

Fields

NameTypeDescription
Tagintptr_t