dsp.CumulativeSum System object

Package: dsp

Cumulative sum of channel, column, or row elements

Description

The CumulativeSum object computes the cumulative sum of channel, column, or row elements.

To compute the cumulative sum of channel, column, or row elements:

  1. Define and set up your cumulative sum object. See Construction.

  2. Call step to compute the cumulative sum according to the properties of dsp.CumulativeSum. The behavior of step is specific to each object in the toolbox.

Construction

H = dsp.CumulativeSum returns a cumulative sum System object™, H, which computes the running cumulative sum for each channel in the input.

H = dsp.CumulativeSum('PropertyName',PropertyValue,...) returns a cumulative sum object, H, with each specified property set to the specified value.

Properties

Dimension

Computation dimension for cumulative sum

Specify the computation dimension as one of | Channels (running sum) | Rows | Columns |. The default is Channels (running sum).

ResetInputPort

Enable resetting cumulative sum via input port.

Set this property to true to enable resetting the cumulative sum. When you set this property to true, you also specify a reset input to the step method to reset the cumulative sum. The default is false.

ResetCondition

Reset condition for cumulative sum

Specify the event on the reset input port that resets the cumulative sum as one of | Rising edge | Falling edge | Either edge | Non-zero |. This property applies when you set the ResetInputPort property to true. The default is Rising edge.

FrameBasedProcessing

Enable frame-based processing

Set this property to true to enable frame-based processing. Set this property to false to enable sample-based processing. You can access this property when the Dimension property is Channels (running sum). The default is false.

 Fixed-Point Properties

Methods

cloneCreate cumulative sum 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 cumulative sum object to zero
stepCumulative sum along specified dimension for input

Examples

Use a cumulative sum object to compute the cumulative sum of a matrix:

 hcsum = dsp.CumulativeSum;
 x = magic(2);
 y = step(hcsum,x);
 y = step(hcsum,x)

Algorithms

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

The Reset port block parameter corresponds to both the ResetCondition and the ResetInputPort object properties

Both this object and its corresponding block let you specify whether to process inputs as individual samples or as frames of data. The object uses the FrameBasedProcessing property. The block uses the Input processing parameter. See Set the FrameBasedProcessing Property of a System object for more information.

Was this topic helpful?