qreport
Most recent fixed-point filtering operation report
Syntax
rlog = qreport(h)
Description
rlog = qreport(h)
returns the logging report stored
in the filter object h
in the object rlog
. The
ability to log features of the filtering operation is integrated in the fixed-point
filter object and the filter
method.
Each time you filter a signal with h
, new
log data overwrites the results in the filter from the previous filtering
operation. To save the log from a filtering simulation, change the
name of the output argument for the operation before subsequent filtering
runs.
Note
qreport
requires Fixed-Point Designer™ software
and that filter h
is a fixed-point filter. Data
logging for fi
operations is a preference you set
for each MATLAB session. To learn more about logging, LoggingMode
,
and fi
object preferences, refer to fipref
in
the Fixed-Point Designer documentation.
Also, you cannot use qreport
to log the filtering
operations from a fixed-point Farrow filter.
Enable logging during filtering by setting LoggingMode
to on
for fi
objects
for your MATLAB session. Trigger logging by setting the Arithmetic
property
for h
to fixed
, making h
a
fixed-point filter and filtering an input signal.
Using Fixed-Point Filtering Logging
Filter operation logging with qreport
requires
some preparation in MATLAB. Complete these steps before you use qreport
.
Set the fixed-point object preference for
LoggingMode
toon
for your MATLAB session. This setting enables data logging.fipref('LoggingMode','on')
Create your fixed-point filter.
Filter a signal with the filter.
Use
qreport
to return the filtering information stored in the filter object.
qreport
provides a way to instrument your
fixed-point filters and the resulting data log offers insight into
how the filter responds to a particular input data signal.
Report object rlog
contains a filter-structure-specific
list of internal signals for the filter. Each signal contains
Minimum and maximum values that were recorded during the last simulation. Minimum and maximum values correspond to values before quantization.
Representable numerical range of the word length and fraction length format
Number of overflows during filtering for that signal.
Examples
Version History
Introduced in R2011a