System object: comm.CCDF
Package: comm
Measure complementary cumulative distribution function
[CCDFY,CCDFX] = step(H,X)
[CCDFY,CCDFX,AVG] = step(H,X)
[CCDFY,CCDFX,PEAK] = step(H,X)
[CCDFY,CCDFX,PAPR] = step(H,X)
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.
[CCDFY,CCDFX] = step(H,X) updates CCDF,
average power, and peak power measurements for input X using
the CCDF System
object, H. It outputs the y-axis, CCDFY,
and x-axis, CCDFX, CCDF points. X must
be a double precision, M-by-N matrix,
where M is the number of time samples and N is
the number of input channels. The step method outputs CCDFY as
a matrix whose i-th column contains updated probability
values measured from the i-th column of input matrix X. CCDFY contains
the y-axis points of the CCDF curves of each channel.
The step method outputs CCDFX as
a matrix containing, in its i-th column, the corresponding
updated instantaneous-to-average power ratios for the ith column of
input matrix X. CCDFX contains
the x-axis points of the CCDF curves of each channel.
The object sets the number of rows in CCDFY and CCDFX equal
to NumPoints property + 1. The probability values
are percentages in the [0 100] interval. When you
set the PowerUnits property to dBW or dBm,
the relative powers are in dB scale. When you set the PowerUnits property
to Watts, the relative powers are in linear scale.
Measurements are updated each time you call the step method until
you reset the object. You call the plot method to plot CCDF curves
for each channel.
[CCDFY,CCDFX,AVG] = step(H,X) returns updated
average power measurements, AVG, when you set the AveragePowerOutputPort property
to true. The step method outputs AVG as a column
vector with the ith element corresponding to an updated average power
measurement for the signal available in the ith column of input matrix X.
You specify the units for AVG in the PowerUnits property.
[CCDFY,CCDFX,PEAK] = step(H,X) returns
updated peak power measurements, PEAK, when you
set the PeakPowerOutputPort property to true. The
step method outputs PEAK as a column vector with
the ith element corresponding to an updated peak power measurement
for the signal available in the ith column of input matrix X.
You specify the units for PEAK in the PowerUnits property.
[CCDFY,CCDFX,PAPR] = step(H,X) returns
updated peak-to-average power ratio measurements, PAPR,
when you set the PAPROutputPort property to true.
The step methods outputs PAPR as a column vector
with the ith element corresponding to an updated peak-to-average power
ratio measurement for the signal available in the ith column of input
matrix X. When you set the PowerUnits property
to dBW or dBm, the method outputs PAPR in
a dB scale. When you set the PowerUnits property
to Watts, the method outputs PAPR in
a linear scale. You can combine optional output arguments when you
set their enabling properties. Optional outputs must be listed in
the same order as the order of the enabling properties. For example,
obj specifies the System
object on
which to run this step method.
The object performs an initialization the first time the step method
is executed. This initialization locks nontunable
properties (MATLAB) and input specifications, such as dimensions,
complexity, and data type of the input data. If you change a nontunable
property or an input specification, the System
object issues an
error. To change nontunable properties or inputs, you must first call
the release method to unlock the object.