TSignalRead Class — DSP Master

class TSignalRead : public TFileStorage;

Reads a signal from the file.

TSignalRead is probably the most important component to understand in order to make effective use of other signal processing components.

Use TSignalRead to read wav, binary and text files and provide streaming capabilities with frame navigation and overlapp support. The read data is placed in the Data property and its sample count is determined with the Length property. Once a file is opened, the key properties immediatelly contain all the necessary information about the file size, number of records, data type etc...

You can connect the component to other components which have an Input property. Example: SpectrumAnalyzer.Input = SignalRead; By calling SpectrumAnalyzer.Pull data will be read from the file and a frequency spectrum will be computed.

Constructors

Name	Description
TSignalRead (2)

Destructors

Name	Description
~TSignalRead

Properties

Name	Type	Description
Active	bool	Set active to false to suppress the propagation of the Pull request and the subsequent call to the Update method.
AutoFileFormat	bool	If True, the file format will be automatically determined from the file name extension.
BandWidth	double	Return the bandwidth of the signal.
BandwidthH	double	Returns the upper bandwidth edge of the signal.
BandwidthL	double	Returns the lower bandwidth edge of the signal.
BlockAssign	bool	Block streaming of specific properties when storing only a "template".
ChannelCount	int	Get or set the number of channels multiplexed in the data property.
Complex	bool	Set this property to true, to request computation using complex numbers.
Continuous	bool	If True, the component will pass on the udpate request to the connected component.
Data	TVec*	Stores the result of the processing.
Dt	double	Time between two consecutive samples.
EditorActive	bool	Returns True, if the component editor is displayed.
FileFormat	TFileFormat	Defines the format of the file, if AutoFileFormat property is False.
FileName	DewString	Defines the file name to be read from or written to.
FloatPrecision	TMtxFloatPrecision	Set this property to request computation in 32bit/64bit precision with real/complex numbers.
FloatPrecisionLock	bool	Set this property to true to lock changes to FloatPrecision property.
ForceLength	bool	Warn about compressed files varying Length read.
FrameNumber	long long	Set FrameNumber to position the read cursor within the current record.
FramesPerSecond	double	Returns the number of frames per second according to Framing and overlapp properties.
Framing	TFraming	Defines the method to traverse a multi-record the file.
HzRes	double	Frequency resolution obtained, if an FFT algorithm would be run on the data.
Input	TSignal*
Inputs	TSignalCollection*
IsDouble	bool	Set this property to false, to request computation in 32bit floating point precision, 64bit, if true.
ItemNumber	int	Number to label the object when it is an item in the List.
LastFrameCheck	TLastFrameCheck	Specifies how to handle the end of file.
Length	int	Get or set the length of the signal in samples.
Loop	bool	If true, looping will be enabled.
Marks	TMarkList*	Stores the time stamps and amplitude of selected samples.
MaxAmplt	double	Stores the maximum amplitude of the signal found by the MinMax method.
MaxFrames	long long	Read Only. Determine the maximum number of frames.
MaxX	double	Use the MaxX property to store the time stamp (in seconds) of the right most sample.
MinAmplt	double	Stores the minimum amplitude of the signal found by the MinMax method.
MinX	double	Use the MinX property to store the time stamp of the left-most sample.
MultiChannel	bool	Set MultiChannel to True, if Inputs property will be published, and Input property will remain hidden.
Name	DewString
NumberOfRecords	int	Read only. Returns the number of records contained in the current file.
OnAfterUpdate	tNotifyEvent	The event is triggered after the call to the Update method.
OnBeforeUpdate	tNotifyEvent	The event is triggered just before the call to the Update method.
OnDisplayUpdate	tNotifyEvent	The event is triggered after the OnAfterUpdate event. Use this event to update any associated charts or graphs or result tables.
OnGetInput	tNotifyEvent	If the Input property is not assigned, the component will call OnGetInput.
OnNotifyUpdate	tNotifyEvent	The event is called after a call to InternalUpdate, OnAfterUpdate and OnDisplayUpdate from within the Update method.
OnParameterUpdate	tNotifyEvent	The 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".
OnProcessAll	tNotifyEvent	Event triggered when Process command is selected from the drop-down menu in the component editor.
OnRecordPositionChange	tNotifyEvent	Triggered after RecordPosition changes.
OverlappingPercent	double	Define the overlapping in percent of consequtive frames when reading the file.
OverlappingSamples	int	Define the overlapping in sampels of consequtive frames when reading the file.
PipeDirty	bool
PipeState	TPipeState	Returns the state of the pipe after the last update.
PostBufferSamples	int	Append zeros to then end of file.
PostBufferTime	double	Append zeros to end of file.
Precision	TPrecision	Read the precision of the data being read from the file.
RecordLength	long long	Read only. Returns the length of the current record in samples for one channel.
RecordNumber	int	Set RecordNumber to move the read cursor within the file to the record with RecordNumber number.
RecordPosition	long long	Set and get position in samples.
RecordTime	double	Read only. Returns the length of the current record in seconds for one channel.
RecordTimePosition	double	Set RecordTimePosition in seconds to position the read cursor within the current record.
Reference	TReferenceList*	Stores a list of components that have to be notified, when this component is destroyed.
SamplingFrequency	double	Defines the sampling frequency of the signal.
SamplingTime	double	The length of the signal in seconds.
ScaleFactor	double	Defines a scale factor to be applied to just read data.
SelectionStart	long long	Specifies the lower file range limit.
SelectionStop	long long	Specifies the upper file range limit.
SuspendNotifyUpdate	bool	Set this property to True, to prevent calling OnNotifyUpdate from the Update Method.
UsesInputs	bool	Set it to True to indicate, that valid signals will be connected to the Input or Inputs properties.

Methods

Name	Description
AllowStreaming
Append	Appends Sample to the end of the signal.
Assign
AssignTemplate	Assign values of "template-like" published properties from Source.
CloseFile	Close file.
Copy	Copies signal Data and sampling frequency information.
Crest	Compute the CREST parameter.
DetectChannelCount
EditorClass
FileIsOpen	Returns true, if the file is open.
FileSize	Returns the size of the file in bytes.
FirstFrame	Sets the record position to the start of the current record and reads the data.
FormatDescription	Returns the description of the file format.
FormatTagDescription	Returns the name of the file format.
get_CValues
get_Values
GetInput
GetInputs
InputsDirty	If all Inputs[i] are dirty the function returns true.
InternalPull
Invalidate	Notifies all connected components that this component has fresh data.
IsEndOfFile	Returns true, if the current frame is the last frame.
LastFrame	Sets the record position to the start of the last frame of the current record and reads the data.
LoadFromStream	Load the component from Src stream.
LoadHeaderFile	Reads the header file for raw file formats.
LoadTemplateFromFile	Load a template from file.
LoadTemplateFromStream	Load a template from stream.
MarksToStrings	Convert marks to strings.
MinMax	Find minimum and maximum amplitude and store the result in the MinAmplt and MaxAmplt properties.
NextFrame	Advances the record position forward in the current record and reads the data.
OpenFile	Open file.
ParamUpdate	The 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.
Peak	Find the maximum deviation of the signal from its mean value.
PipeReset	Recursively processes all connected components backward and calls Reset method.
PrevFrame	Moves the record position backward in the current record and reads the data.
Pull	Request recalculation of the entire chain of all connected components.
PullUntilEnd	Calls Pull until pipeEnd is returned.
RawFileFormat	Checks if the file format is raw.
ReferenceRemoved
Reset
SamplesLeft	Returnes the number of samples left to the end of the file per channel.
SaveHeaderFile	Saves a header file describing file contents.
SaveTemplateToFile	Save template to file.
SaveTemplateToStream	Save template to stream.
SaveToStream	Save the component to Dst stream.
set_CValues
set_Values
SetComplex
SetFloatPrecision
SetInputs
SetIsDouble
SetSamplingFrequency
Size	Assign the size of the signal from Src.
Update	Request recalculation of the data and place the result in Self.
UpdateNotify	Call this method only, if SuspendNotifyUpdate is True.
Values
ValuesToStrings	Convert values to strings.

Operators

Name	Description
operator[]

Fields

Name	Type	Description
Tag	intptr_t