The RMS
object computes the root mean square
(RMS) value.
To compute the RMS value of your input:
Define and set up your RMS calculation. See Construction.
Call step
to compute the RMS value for an input
according to the properties of dsp.RMS
. The behavior
of step
is specific to each object in the toolbox.
H = dsp.RMS
returns
a System object™, H
, that computes the root mean
square (RMS) of an input or a sequence of inputs over the specified Dimension
.
H = dsp.RMS('
returns
an PropertyName
',PropertyValue
,...)RMS
System object, H
, with
each specified property set to the specified value.

Enable calculating RMS over time Set this property to Default: 

Enable resetting in running RMS mode Set this property to Default: 

Reset condition for running RMS mode Specify the event to reset the running RMS as one of Default: 

Dimension to compute RMS value along Specify the dimension along which to calculate the RMS as one
of Default: 

Numerical dimension to operate along Specify the dimension (onebased scalar integer value) of the
input signal, along which the RMS is computed. The cannot exceed the
number of dimensions in the input signal. This property applies when
you set the Default: 
clone  Clones the current instance of the root mean square object 
getNumInputs  Number of expected inputs to the step method 
getNumOutputs  Number of outputs of the step method 
isLocked  Locked status for input attributes and nontunable properties 
release  Allow property value and input characteristics changes 
reset  Reset the running root mean square object 
step  Root mean square of input 
The rootmeansquare level of a vector, X, is
with the summation performed along the specified dimension.
A rising edge:
Rises from a negative value to a positive value or zero.
Rises from zero to a positive value, where the rise is not a continuation of a rise from a negative value to zero.
A falling edge:
Falls from a positive value to a negative value or zero.
Falls from zero to a negative value, where the fall is not a continuation of a fall from a positive value to zero.
This object implements the algorithm, inputs, and outputs described on the RMS block reference page. The object properties correspond to the Simulink^{®} block parameters, except:
Treat samplebased row input as a column block
parameter is not supported by the dsp.RMS
object.
Reset Port block parameter corresponds
to both the ResetCondition
and the ResetInputPort
object
properties.