addWave

Add wave to Logic Analyzer

Syntax

waveTag = addWave(scope)

waveTag = addWave(scope,Name,Value)

Description

waveTag = addWave(scope) adds a wave to the display. A tag value is returned, which can be used to modify and delete the wave.

waveTag = addWave(scope,Name,Value) sets properties using one or more name-value pairs. Enclose each property name in single quotes.

Examples

Manipulate Logic Analyzer Programmatically

Use functions to construct and manipulate a dsp.LogicAnalyzer System object.

Display Waves on Logic Analyzer scope.

scope = dsp.LogicAnalyzer('NumInputPorts',2);

stop = 30;
for count = 1:stop
    sinValVec = sin(count/stop*2*pi);
    cosValVec = cos(count/stop*2*pi);
    cosValVecOffset = cos((count+10)/stop*2*pi);
    
    scope([count (count-(stop/2))],[sinValVec cosValVec cosValVecOffset]) 
end

Reorganize Display

hide(scope)
digitalDividerTag = addDivider(scope,'Name','Digital','Height',20);
analogDividerTag = addDivider(scope,'Name','Analog','Height',40);

tags = getDisplayChannelTags(scope);

modifyDisplayChannel(scope,tags{1},'InputChannel',1,...
    'Name','Ramp Digital','Height',40);
modifyDisplayChannel(scope,tags{2},'InputChannel',2,...
    'Name','Waves Analog','Format','Analog','Height',80);

moveDisplayChannel(scope,digitalDividerTag,'DisplayChannel',1)
moveDisplayChannel(scope,tags{2},'DisplayChannel',length(tags))

show(scope)

Duplicate Wave and Check Information

hide(scope)
addWave(scope,'InputChannel',2,'Name','Waves Digital','Format','Digital',...
    'Height',30,'DisplayChannel',3);
show(scope)

Remove Dividers

hide(scope)
deleteDisplayChannel(scope,digitalDividerTag)
deleteDisplayChannel(scope,analogDividerTag)
show(scope)

Clear variables

clear analogDividerTag cosValVec cosValVecOffset count digitalDividerTag duplicateWave scope sinValVec stop tags

Input Arguments

scope — The Logic Analyzer object to which you want to add a wave

dsp.LogicAnalyzer object

Example: 'addWave(scope)' adds a wave with the default characteristics.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'InputChannel',2,'Color','Blue' specifies that a wave should be added to input channel 1 and colored blue.

Color — Color of the wave

'Default' (default) | character vector | three element numeric vector | string scalar

Color of the wave, specified as an [R G B] value or one of the following:

• 'Black'

• 'Blue'

• 'Cyan'

• 'Default'

• 'Green'

• 'Magenta'

• 'Red'

• 'White'

• 'Yellow'

When you choose 'Default', the value of the DisplayChannelColor property in the Logic Analyzer is used.

Example: 'Color','Blue'

Example: 'Color',[0,0,1]

Data Types: char | string | double | single | uint8 | uint16 | uint32 | uint64 | int8 | int16 | int32 | int64

DisplayChannel — Channel on the display that shows this wave

NumInputPorts (default) | scalar numeric value in the range (1,NumInputPorts)

Specify as a scalar numeric value the display channel that shows this wave. By default, the wave is added to the end of the display.

Example: 'DisplayChannel',2

Data Types: double | single | uint8 | uint16 | uint32 | uint64 | int8 | int16 | int32 | int64

FontSize — Font size for values in the wave

0 (default) | scalar nonnegative integer

Specify as a scalar nonnegative integer the font size in points. When you choose 0, the value of the DisplayChannelFontSize property in the Logic Analyzer is used.

Example: 'FontSize',8

Data Types: double

Format — Display format for the wave

'Default' (default) | 'Analog' | 'Digital'

When you choose 'Default', the value of the DisplayChannelFormat property in the Logic Analyzer is used.

Example: 'Format','Digital'

Data Types: char | string

Height — Height of the wave

0 (default) | scalar integer

Specify as a scalar integer the height of the wave in the display in units of 16 pixels. When you choose 0, the value of the DisplayChannelHeight property in the Logic Analyzer is used.

Example: 'Height',2

Data Types: double

InputChannel — Input channel that corresponds to this wave

1 (default) | scalar integer in the range (1,NumInputPorts)

This property specifies the input channel whose data is used for this wave. By default, it will connect the first input to this wave.

Example: 'InputChannel',2

Data Types: double | single | uint8 | uint16 | uint32 | uint64 | int8 | int16 | int32 | int64

Name — Name or label for the wave

'' (default) | character vector | string scalar

Specify the name that you would like to set for the new wave.

Example: 'Name','MyWave'

Data Types: char | string

Radix — Radix for the wave

'Default' (default) | 'Binary' | 'Hexadecimal' | 'Octal' | 'Signed decimal' | 'Unsigned decimal'

When the input signals are of class double, single, or logical, you should not set this property. When you choose 'Default', the value of the DisplayChannelRadix property in the Logic Analyzer is used.

Data Types: char | string

Output Arguments

waveTag — tag for new wave

random character vector

A tag for the newly added wave. Use the tag name to modify and delete the wave.

Version History

Introduced in R2013a