Note: This page has been translated by MathWorks. Click here to see

To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

Root mean square of vector elements

The `dsp.RMS`

object computes the root mean square (RMS)
value.

The `Running`

mode in the `dsp.RMS`

System
object™ will be removed in a future release. To compute the running RMS in MATLAB^{®}, use the `dsp.MovingRMS`

System
object instead.

To compute the RMS value of your input:

Create the

`dsp.RMS`

object and set its properties.Call the object with arguments, as if it were a function.

To learn more about how System objects work, see What Are System Objects? (MATLAB).

`rms = dsp.RMS`

`rms = dsp.RMS(Name,Value)`

**For versions earlier than R2016b, use the step
function to run the System object algorithm. The arguments to
step are the object you created, followed by
the arguments shown in this section.**

**For example, y = step(obj,x) and y = obj(x) perform equivalent operations.**

`y = rms(x)`

`y = rms(x,r)`

To use an object function, specify the
System
object as the first input argument. For
example, to release system resources of a System
object named `obj`

, use
this syntax:

release(obj)

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:

The

**Treat sample-based row input as a column**block parameter is not supported by the`dsp.RMS`

object.The

**Reset Port**block parameter corresponds to both the`ResetCondition`

and the`ResetInputPort`

object properties.

`dsp.Minimum`

|`dsp.MovingRMS`

|`dsp.MovingStandardDeviation`

|`dsp.MovingVariance`

|`dsp.StandardDeviation`

|`dsp.Variance`