The PeakToRMS
object calculates the peaktorootmeansquare
ratio of a vector.
To compute the peaktorootmeansquare ratio:
Define and set up your peaktorootmeansquare calculation. See Construction.
Call step
to calculate the peaktorootmeansquare
value for an input vector according to the properties of dsp.PeakToRMS
.
The behavior of step
is specific to each object in
the toolbox.
Note:
Starting in R2016b, instead of using the 
H = dsp.PeakToRMS
creates
a peaktorootmeansquare System object, H
,
that returns the ratio of the maximum magnitude (peak) to the rootmeansquare
(RMS) value in an input or a sequence of inputs.
H = dsp.PeakToRMS('
returns
an PropertyName
',PropertyValue
,...)PeakToRMS
System object, H
,
with each specified property set to the specified value.

Numerical dimension to operate along. Specify the dimension
as a positive integer along which the peaktoRMS ratio is computed.
The value of this property cannot exceed the number of dimensions
in the input signal. This property applies when Default: 

Report output in decibels (dB). Set this property to Default: 

Dimension to operate along. Specify the dimension along which
to calculate the peaktoRMS ratio as one of Default: 

Reset condition for running peaktoRMS mode. Specify the event
to reset the running peaktoRMS as one of 

Enables resetting in running peaktoRMS mode. Set this property
to Default: 

Calculation over successive calls to Default: 
clone  Clones the current instance of the peaktorootmeansquare object 
getNumInputs  Number of expected inputs to the step method 
getNumOutputs  Number of outputs of the step method 
isLocked  Locked status (logical) for input attributes and nontunable properties 
release  Allow property value and input characteristics changes 
reset  Reset the running peaktorootmeansquare object 
step  Compute peaktoRMS ratio 
The peakmagnitudetoRMS level is
$$\frac{\left\rightX{}_{\infty}}{\sqrt{{\scriptscriptstyle \frac{1}{N}}{\displaystyle \sum _{n=1}^{N}}{X}_{n}{}^{2}}}$$
where the linfinity norm and RMS values are computed along the specified dimension.
[1] IEEE^{®} Standard on Transitions, Pulses, and Related Waveforms, IEEE Standard 181, 2003.