iicom

Contents Functions Index

PDF

iicom

Purpose

UI command function for FRF data visualization.

Syntax

iicom
iicom CommandString
iicom(ci,'CommandString')
message = iicom('CommandString','TailChar')

Description

iicom is a standard UI command function which performs operations linked to the data visualization within the iiplot interface. Commands (see the commode help for hints on how to build commands and understand the variants discussed in this help) are text strings telling iicom what to do. If many iiplot figures are open, one can define the target giving an iiplot figure handle ci as a first argument.

When needed, iicom uses data stored in a stack (see section 3.1.2). iicom does not modify data. A list of commands available through iicom is given below. These commands provide significant extensions to capabilities given by the menus and buttons of the iiplot command figure. A tutorial can be found in section 3.1.

Commands

;

Command chaining. Commands with no input (other than the command) or output argument, can be chained using a call of the form iicom(';Com1;Com2'). commode is then used for command parsing.

ad i, adc i

Display addresses i. Only a restricted number of channels (columns data sets) are displayed in the drawing axes. Addresses are arbitrary integer numbers used to identify channels. Addresses are stored in the third column of the .dof field which has as many rows as there are channels (see xfopt). ad / adc respectively define the addresses (and find the corresponding channels) to be displayed in all / the current drawing axes. The vector of addresses is defined by evaluating the string i. For example ad 101, displays the channel with address 101 in all axes.

cax i, ca+

Change current axes. cax i makes the axis i (an integer number) current. ca+ makes the next axis current. For example, iicom(';cax1;show rea;ca+;show ima') displays the real part of the current FRFs in the first axis and their imaginary part in the second. (See also the iicom Sub command). The button indicates the number of the current axis. Pressing the button executes the ca+ command.

ch+, ch-, ch[+,-]i

Next/Previous. These commands/buttons are used to scan through plots of the same kind. For iiplot axes, this is applied to the current data sets. For feplot axes, the current deformation is changed. You can also increment/decrement channels using the + and - keys when the current axis is a plot axis or increment by more than 1 using iicom('ch+i').

ch i, chc i

Display channels/poles/deformations i. Channels refer to columns of datasets, poles or deformations. ch / chc respectively define the indices of the channels to be displayed in all / the current drawing axes. The vector of indices is defined by evaluating the string i. For example iicom ch[1:3], displays channels 1 to 3 in all axes.

Curve[Load,Save,Reset, ...]

These commands are used to manipulate datasets.

CurveLoad lets you load datasets.
iicom('CurveLoad FileName') loads curves stored in Filename.
iicom('CurveLoad') opens a dialog box to choose the file containing curves to load. If the file contains multiple curves, one can select the curves to be loaded in a cell array given as a second argument. For example,
```
[ci,XF]=iicom('CurveLoad','gartid.mat')
```
loads the gartid data in an iiplot figure. iicom(ci,'CurveLoad -append MyFile') lets you append loaded curves to existing curves in the stack.
CurveSave lets you save iiplot stack data.
iicom('CurveSave FileName',CurveNames) saves the curves whose names are given in the cell array CurveNames, in the .mat file given by FileName. If one of those two arguments is omitted a GUI is opened.
```
fname=fullfile(sdtdef('tempdir'),'IicomSaveTestmat')
iicom(['CurveSave' fname],{'IIxi';'IdMain'})
```
iicom(ci,'CurveNewId CurveName') opens new iiplot figure for identification of the curve CurveName of the ci stack with idcom.
iicom('CurveLoadId',FileName) loads SDT 5 data from FileName into a curve stack for identification.
iicom('CurveRemove CurveName') removes the curve CurveName from the stack of the iiplot figure.
CurveReset defines an empty curve stack to renew your work.
CurveXF returns a data stack pointer: XF=iicom('CurveXF')
CurveJoin combines datasets that have comparable dimensions. In particular first dimension (time, frequencies ...) must be the same. For example it is useful to combine dataset from parameter studies (same dimension). Curve to be joined should be given by their name in the string command: iicom('CurveJoin curve1 curve2 ...') joins curve(s) named curve2, ... to the curve named curve1. Resulting curve is stored under the name curve1. If curve names are not given, iicom('CurveJoin') joins current dataset displayed in the iiplot figure (see iicom IIx to select in iiplot stack the curves to be displayed).
CurveCat concatenates dataset that have the same dimension. For example it is useful to combine dataset from successive time simulation. Syntax is the same as for iicom CurveJoin command.

ga i

Get handle to a particular axis. This is used to easily modify handle graphics properties of iiplot axes accessed by their number. For example, you could use set(iicom('ga1:2'),'xgrid','on') to modify the grid property of iiplot axes 1 and 2.

If you use more than one feplot or iiplot figure, you will prefer the calling format cf=iiplot; set(cf.ga(1:2),'xgrid','on').

head [Main,Text,Clear]

Figure header utilities. Header axes are common to all plot functions and span the full figure area (normalized position [0 0 1 1] ). The SDT also tries to keep this on top to that the information is always visible. iimouse also raises it when you click outside the area covered by other axes. Any information that you would want to be present on all your plots should be plotted on this axis.

iicom('HeadMain') defines the main header title based on the first stack entry XF(1).header (see xfopt). You can also specify a string and additional properties that are valid for MATLAB text objects. For example,

  iicom('head main','Main Title','fontsize',20,'fontname','Times')

iimouse supports modifications (font, string, position) of this title by providing a context menu (click on the text using the right mouse button). For command based modifications of this object, you can also get its handle using findobj(cf.head, 'tag', 'iimain') (where cf is a SDT handle to the iiplot or feplot figure).

You can put additional text strings in the axis using iicom('HeadText') with the same format as HeadMain. These objects are created with the iitext tag.

iicom('HeadClear') deletes all objects from the header axis of the current figure. To find the pointer to the header axis of a given figure use cf.head. This can be useful if you want to add other objects that just text.

Note: the obsolete HeadAdLabel command is by the use of user defined titles (see the iicom TitOpt command).

IIpo [ ,1], cIIpo[ ,1,tog]

Poles/residues displayed. iiplot displays either the main identified model
XF('IdMain').po or the alternate set XF('IdAlt').po. These commands tell iiplot which set to show. By adding a c in front of the command (cIIpo for example), the choice is only applied to the current axis. You can also toggle which of IIpo or IIpo1 is shown using the Variables:IIpo menu (ciitog command).

IIx:name [On,Off,Only], cIIx ...

Curve set selection for display in the current axis.

IIxf:TestOnly displays the XF('Test') data set only in all axes (on and off turn the display on or off respectively). By adding a c in front of the command (cIIx:Test for example), the choice is only applied to the current axis. You can also toggle which of the data sets are shown using the Variables menu (applies to all axes) or axis context menu applies to (current axis).

The alternate calling format iicom('iix',{'Test','IdMain'}) can be used to specify multiple sets to display. iicom('iixOnly',{'Test','IdMain'}) will display those two sets only.

IIxf, IIxe, IIxh, IIxi [0n,Off] are still supported for backward compatibility.

info

Information on the current state of the interface. This is equivalent to cf=iiplot; disp(cf).

ods

Operational deflection shape cursor.

PoleLine [ ,c] [ ,3]

Pole line display. By itself, PoleLine toggles the state of pole line display (vertical lines showing the frequencies of poles in XF('IdMain') in black and XF('IdAlt') in red). The c applies the command to the current axis only. PoleLine3 places the lines on the pole norm rather than imaginary part used by default (this corresponds to the ii_plp formats 2 and 3).

The state of the current axis (if it is an iiplot axis) can also be changed using the IIplot:PoleLine menu (PoleLineTog command).

Print, Preprint

Print prints the figure of the current iiplot or feplot axis. It changes the current figure if necessary and adds -noui to the print options before calling the matlab print command.

Preprint sets the size of the current figure to the physical PaperSize. This is useful to make sure that what you see on the screen is what you will print. In particular legends are based on physical sizes so that the output you get is dependent on the window size.

Pro

iicom('ProFig') shows or hides the properties figure.
iicom(ci,'ProRefreshIfVisible') refreshes the property figure when it is visible.
iicom(ci,'ProInit') reinits the property figure.

Show Type

Specify the current axis type. The iiplot plot functions support a number of plot types which can be selected using the Show menu. For all data sets, you can use

abs	amplitude (also mag)
pha	wrapped phase	phu	unwrapped phase
rea	real part	ima	imaginary part
r&i	real and imaginary	nyq	Nyquist plot

When using idcom, standard views for mode indicators and identification quality checks can be obtained as follows

mmi	MMIF of Test
fmi	forces of MMIF of Test
ami	alternate mode indicator of Test
sum	SUM of Test
cmi	CMIF of Test
sumi	sum imaginary part of Test
pol	poles in IdMain
fre	freq. vs. damping in IdMain
rre	real residue in IdMain
cre	complex residue of IdMain
lny	local Nyquist of Test (superposition around current pole)
err	Nyquist Error for current pole
qual	Quality for all poles

Sub[Save,Set]

SubSavei saves the current configuration of the iiplot interface to the stack. This configuration can then be recalled with SubSeti.

Sub [MagPha, i j k[ ,nd][ ,step]]

This command is the entry point to generate multiple drawing axes within the same figure.

iicom Sub by itself checks all current axes and fixes anything that is not correctly defined.

SubMagPha gives a standard subdivision showing a large amplitude plot and a small wrapped phase plot below. SubIso gives a standard 2 by 2 subdivision showing four standard 2-D projections of a 3-D structure.

Sub i j k divides the figure in the same manner as the MATLAB subplot command. If k is set to zero all the i times j axes of the subplot division are created. Thus the default call to the Sub command is 'Sub 2 1' which creates two axes in the current figure. If k is non zero only one of these axes is created as when calling subplot(i,j,k).

As the subplot function, the Sub command deletes any axis overlapping with the new axis. You can prevent this by adding nd to the command string.

The optional step modifier increments the deformation shown in each subplot. This is generally used to show various modeshapes in the same figure.

Standard subdivisions are accessible by the IIplot:Sub commands menu.

Note that set(cf.ga(i),'position',Rect) will modify the position of iiplot axis i. This axis will remain in the new position for subsequent refreshing with iiplot.

TitOpt [ ,c]i

Automated title/label generation options. TitOpti sets title options for all axes to the value i. i is a 5 digit number with

units corresponding to title. For modes [None,ModeNumber,Name].
decades to xlabel 0 none, 1 label and units, 2 label
hundreds to ylabel 0 none, 1 label and units, 2 label
thousands to zlabel 0 none, 1 label and units, 2 label
1e4 to legend/title switching.

The actual meaning of options depends on the plot function (see iiplot for details). By adding a c after the command (titoptc 111 for example), the choice is only applied to the current axis.

When checking the axes data (using iicom Sub command), one rebuilds the list of labels for each dataset using iicom('chlab'). This cell array of labels, stored in ci.ua.chlab, gives title strings for each channel (in rows) of datasets (in columns) with names given in ci.ua.sList. The label should start with a space and end with a comma. The dataset name is added if multiple datasets are shown.

Modifying the ci.IDopt.unit value changes the unit assumed for identification but not the dataset units.

Titles and labels are not regenerated when using ch commands. If something is not up to date, use iicom Sub which rechecks everything.

xlin,xlog, [ ,all] ...

Default values for xscale and yscale. xlin, xlog, ylin, ylog, set values. xy+1, xy+2 are used to toggle the xscale and yscale respectively (you can also use the IIplot:xlin and IIplot:ylin menus). Other commands are xy1 for x-lin/y-lin, xy2 for x-log/y-lin, xy3 for x-lin/y-log, xy4 for x-log/y-log.

You can all use the all qualifier to change all axes : iicom('xlog all').

wmin, wmax, w0, ...

Min/max frequency selection. Frequency bands are selected through the indices IDopt (4:5) for the first and last frequency.

wmin f	is used to find in IIw the index of the frequency point closest to f. IDopt (4) is then set to the value of this index. You can actually give minimum and maximum values using wmin f1 f2.
wmax f	sets IDopt (5) to the index of the frequency closest to f.
wmo	allows a mouse selection of the minimum and maximum frequency
w0	resets the values to cover the complete frequency range
wnext	shifts a reduced frequency window to the right (this is the action of the button)

The toolbar shown above gives access to the commands wmin, wnext, wmax.

but may change identification options except for the frequency band indices
(ci.IDopt.Select stored in IDopt(4:5)) which are modified by the w commands.

See also

iiplot, section 3.1, idcom

©1991-2007 by SDTools