Documentation

dsp.SignalSink System object

Package: dsp

Log simulation data in buffer

Description

The SignalSink object logs MATLAB® simulation data. This object accepts any numeric data type.

To log MATLAB simulation data :

  1. Define and set up your signal sink. See Construction.

  2. Call step to log the simulation data according to the properties of dsp.SignalSink. The behavior of step is specific to each object in the toolbox.

Construction

H = dsp.SignalSink returns a signal sink, H, that logs 2-D input data in the object.

H = dsp.SignalSink('PropertyName',PropertyValue,...) returns a signal sink, H, with each specified property set to the specified value.

Properties

BufferLength

Maximum number of input frames to log

Specify the maximum number of frames to log. The object always preserves the most recent data in the buffer. When you specify a buffer length that is greater than the input length, the object pads the end of the logged data with zeros. To capture all input data without extra padding, set the BufferLength property to inf. The default is inf.

Decimation

Decimation factor

Setting this property to any positive integer d causes the signal sink to write data at every dth sample. The default is 1.

FrameHandlingMode

Output dimensionality for frame-based inputs

Set the dimension of the output array for frame-based inputs as 2-D array (concatenate) or 3-D array (separate). Concatenation occurs along the first dimension for 2-D array (concatenate). The default is 2-D array (concatenate).

Buffer

Logged Data (read only)

The signal sink writes simulation data into a buffer. Specify the maximum length of the buffer with the BufferLength property.

Methods

cloneCreate signal logger object with same property values
getNumInputsNumber of expected inputs to step method
getNumOutputsNumber of outputs of step method
isLockedLocked status for input attributes and nontunable properties
releaseAllow property value and input characteristics changes
resetReset internal states of signal logger object
stepStore signal in buffer

Examples

Log input data.

hlog = dsp.SignalSink;
 for i=1:10
     y = sin(i);
     step(hlog,y);
 end
log = hlog.Buffer; % log = sin([1;2;3;4;5;6;7;8;9;10])

Algorithms

This object implements the algorithm, inputs, and outputs described on the To Workspace block reference page. The object properties correspond to the block properties, except:

The object always generates fixed-point output for fixed-point input.

Was this topic helpful?