System object: dsp.DelayLine
Package: dsp

Delayed version of input


Y = step(H,X)
Y = step(H,X,EN)


Y = step(H,X) returns the delayed version of input X. Y is an output matrix with the same number of rows as the delay line size. Each column of X is treated as a separate channel.

The System object™ rebuffers a sequence of Mi-by-N matrix inputs into a sequence of Mo-by-N matrix outputs, where Mo is the output frame size specified by the Length property. Depending on whether Mo is greater than, less than, or equal to the input frame size, Mi, the output frames can be underlapped or overlapped. Each of the N input channels is rebuffered independently:

  • WhenMo > Mi, the output frame overlap is the difference between the output and input frame size, MoMi.

  • When Mo < Mi, the output is underlapped; the object discards the first MiMo samples of each input frame so that only the last Mo samples are buffered into the corresponding output frame.

  • When Mo = Mi, the output data is identical to the input data, but is delayed by the latency of the object.

Y = step(H,X,EN) selectively outputs the delayed version of input X depending on the Boolean input EN. This occurs only when you set the EnableOutputInputPort property to true. If EN is false, use the HoldPreviousValue property to specify if the object should hold the previous output value(s).

    Note:   H specifies the System object on which to run this step method.

    The object performs an initialization the first time the step method is executed. This initialization locks nontunable properties and input specifications, such as dimensions, complexity, and data type of the input data. If you change a nontunable property or an input specification, the System object issues an error. To change nontunable properties or inputs, you must first call the release method to unlock the object.

Was this topic helpful?