comm.IntegrateAndDumpFilter
Integrate discretetime signal with periodic resets
Description
The IntegrateAndDumpFilter
object creates a
cumulative sum of the discretetime input signal, while resetting
the sum to zero according to a fixed schedule. When the simulation
begins, the object discards the number of samples specified in the
Offset property. After this initial period, the object sums the input
signal along columns and resets the sum to zero every Ninput
samples, set by the integration period property. The reset occurs
after the object produces output at that time step.
To integrate discretetime signals with periodic resets:
Define and set up your integrate and dump filter object. See Construction.
Call
step
to integrate discretetime signals according to the properties ofcomm.IntegrateAndDumpFilter
. The behavior ofstep
is specific to each object in the toolbox.
Note
Starting in R2016b, instead of using the step
method
to perform the operation defined by the System object™, you can
call the object with arguments, as if it were a function. For example, y
= step(obj,x)
and y = obj(x)
perform
equivalent operations.
Construction
H = comm.IntegrateAndDumpFilter
creates
an integrate and dump filter System object, H
.
this object integrates over a number of samples in an integration
period, and then resets at the end of that period.
H = comm.IntegrateAndDumpFilter(
creates
an integrate and dump filter object, Name
,Value
)H
, with each
specified property set to the specified value. You can specify additional
namevalue pair arguments in any order as (Name1
,Value1
,...,NameN
,ValueN
).
H = comm.IntegrateAndDumpFilter(PERIOD,
creates
an integrate and dump filter object, Name
,Value
)H
. This
object has the IntegrationPeriod
property set to PERIOD
and
the other specified properties set to the specified values.
Properties

Integration period Specify the integration period, in samples, as a positive, integer
scalar value greater than 

Number of offset samples Specify a nonnegative, integer vector or scalar specifying the
number of input samples that the object discards from each column
of input data at the beginning of data processing. Discarding begins
when you call the When you set the When you specify this property as a vector of length L, the ith element of the vector corresponds to the offset for the ith column of the input data matrix, which has L columns. When you specify this property as a scalar value, the object applies the same offset to each column of the input data matrix. The offset creates a transient effect, rather than a persistent delay. 

Decimate output Specify whether the When you set this property to When you set this property to 
Methods
step  Integrate discretetime signal with periodic resets 
Common to All System Objects  

release  Allow System object property value changes 
Examples
More About
Algorithms
This object implements the algorithm, inputs, and outputs described on the Integrate and Dump block reference page. The object properties correspond to the block parameters, except:
The Output intermediate values parameter corresponds to the DecimateOutput property. 
Extended Capabilities
Version History
Introduced in R2012a