Contents     Functions              PDF Index

ii_plp

• plp
• .ID PoleLine Call from iiplot
• Legend
• PlotSubMark
• spy
• TickFcn
• ColorMap

Purpose

Pole line plots and other plot enhancement utilities.

Syntax

ii_plp(po)
ii_plp(po,color,Opt)

Description

plp

Generation of zoomable vertical lines with clickable information.

ii_plp(po) will plot vertical dotted lines indicating the pole frequencies of complex poles in po and dashed lines at the frequencies of real poles. The poles po can be specified in any of the 3 accepted formats (see ii_pof).

When you click on these lines, a text object indicating the properties of the current pole is created. You can delete this object by clicking on it. When the lines are part of iiplot axes, clicking on a pole line changes the current pole and updates any axis that is associated to a pole number (local Nyquist, residue and error plots, see iiplot).

.ID PoleLine Call from iiplot

When displaying a curve in iiplot, one can generate automatic calls to ii_plp. Curve.ID field can be used to generate automatically vertical lines in iiplot. It is a cell array with as many cell as line sets. Each cell is a data structure defining the line set. Following fields can be defined:

• .po can be a column vector defining abscissa of vertical lines. It can also be a string, possibly depending on the displayed curve XF1 and the channel through variable ch to be evaluated to define the ro.po vector, for example 'r1.po=XF1.Y2(:,ch);'.
• .LineProp is optionnal. One can specify some MATLAB line properties in this field as a cell array {'prop1', value1, 'prop2', value2, ...}, for example {'LineStyle',':','color','r'}.
• .name is used to generate a text info displayed when the user clicks on the line.
• .unit(obsolete) is used for Hz vs. rad/s unit conversion. With tens set to 1 (11 or 12) is used for poles in Hz, while those with tens set to 2 correspond to Rad/s. This value is typically obtained from IDopt(3).
• .format an integer that specifies whether the imaginary part Im(λ) (Format=2 which is the default) or the amplitude |λ| (using Format=3 corresponding to format 3 of ii_pof) should be used as the “frequency” value for complex poles.

Legend

Dynamic multi-line legend generation used by iiplot and feplot

ii_plp('legend',ga,prop) with properties a cell array detailed with in comgui def.Legend (typical legend generation associated with FEM solutions).

ii_plp('legend -corner .01 .01 -reset ',ga,ua,StringCell,legProp) is an older format found in some calls.

• cornerx y gives the position of the legend corner with respect to the current axis.
• -reset option deletes any legend existing in the current axis.
• ga handle to the axis where the axes is to be placed, see gca.
• ua if not empty provides additional properties.
• StringCell cell array of strings with one per line of legend.
• legProp non default text properties to be used for the legend.

PlotSubMark

Generate subsampled markers.

spy

Generates a spy plot with color coding associated with the non-zero element values.

• unsymm is used to force non symmetric plots.
• threshold is used force small terms to zero.

TickFcn

SDT implements a general mechanism for enhancing the basic dynamic label generation of MATLAB. This allows placement of strings are proper locations on an axis. This functionality is not fully documented and you are encouraged to look-up the source code. SDT generated plots expect the following fields in the axis userdata ua.TickInfo for data and ua.TickFcn for the callback. A sample usage would be

C1=struct('X',{{num2cell(2:4)' 2}},'Xlab',{{'x','y'}}, ...
 'Y',(1:3)')
figure(1);plot(1:3,C1.Y);ii_plp('tickXCell',C1,gca);
C1=ii_plp('tickXCell',C1); %Defines the PlotInfo

ColorMap

FEM oriented color maps.

See also

ii_pof, idopt, iiplot, iicom