Main Content

highlight

Highlight path to signal sources or destinations in model

Since R2021b

Description

highlight(g) highlights in the block diagram the blocks and signal lines in the sltrace.Graph object g.

example

highlight(g,t) highlights in the block diagram the blocks and signal lines specified by t.

Examples

collapse all

The model for this example implements the second-order differential Van der Pol (vdp) equation.

d2xdt2-μ(1-x2)dxdt+x=0,

where μ represents damping in the system.

Open the model vdp. In the model, the signal x1 represents the first derivative of x. The signal x2 represents the second derivative of x.

mdl = "vdp";
open_system(mdl)

The model vdp.

Use the sltrace function to trace all source blocks for the signal x2, which is the input signal for the Integrator block named x1.

x2Sources = sltrace((mdl + "/x1"),"Source",Port=1,TraceAll="on");

When you trace all sources for a signal, the sltrace.Graph object that the sltrace function returns contains information about more than just the blocks that produce the input signals for the specified block. The sltrace.Graph object contains information for all blocks that produce output values that affect the value of the signal you trace.

length(x2Sources.SrcBlocks)
ans = 10

To see the signal path in the block diagram, use the highlight function to highlight all the source blocks in the sltrace.Graph object x2Sources. The source blocks in the sltrace.Graph object and the signals that connect them are highlighted yellow in the block diagram. Highlighting the blocks also shades the canvas a darker grey to make the highlighting more visible.

highlight(x2Sources)

The model vdp has all source blocks for the signal x2 highlighted.

The sltrace.Graph object includes a digraph object you can use to analyze the connections among the source blocks. Each node in the graph represents a block port, and each edge, or line, represents a signal line.

plot(x2Sources.TraceGraph)

Figure contains an axes object. The axes object contains an object of type graphplot.

Once you have an sltrace.Graph object, you can use the highlight function to highlight any block or signal line in the model, including blocks and signal lines that are not part of the signal trace information in the sltrace.Graph object. For example, highlight the Scope block and the signal lines connected to the input ports on the Scope block.

Use the get_param function to get the block handle for the Scope block.

scopePath = mdl + "/Scope";
scopeHandle = get_param(scopePath,"Handle");

Use the get_param function to get the port handles for the Scope block.

scopePorts = get_param(scopePath,"PortHandles");

Use the get_param function to get the line handle for the signal line connected to each input port of the Scope block.

scopeIn1 = scopePorts.Inport(1);
scopeIn1 = get_param(scopeIn1,"Line");
scopeIn2 = scopePorts.Inport(2);
scopeIn2 = get_param(scopeIn2,"Line");

Use the highlight function to highlight the elements in the block diagram. The Scope block and the input signals for the Scope block are highlighted red in the block diagram, which still shows the yellow highlighting on the sources for the signal x2.

highlight(x2Sources,[scopeHandle scopeIn1 scopeIn2])

The model vdp has the sources for the signal x2, the Scope block, and the inputs to the Scope block highlighted in the block diagram.

To remove the highlighting, use the removeHighlight function. The function removes all highlighting in the block diagram associated with the sltrace.Graph object. When the block diagram contains no highlighting, the shading in the canvas is also removed.

removeHighlight(x2Sources)

The model vdp has no highlighting in the block diiagram.

Input Arguments

collapse all

Signal tracing path information created using the sltrace function, specified as an sltrace.Graph object.

Blocks and signal lines to highlight, specified as a block handle, a line handle, or an array of block and line handles. You can use the highlight function to highlight any block in the model that corresponds to the sltrace.Graph object, including blocks and signal lines that are not on the tracing path that the object represents.

Version History

Introduced in R2021b