Probe

Output signal attributes, including width, dimensionality, sample time, and complex signal flag

  • Library:
  • Simulink / Signal Attributes

    HDL Coder / Signal Attributes

Description

The Probe block outputs selected information about the signal on its input. The block can output the following attributes of the input signal: width, dimensionality, sample time, and a flag indicating whether the input is a complex-valued signal. The block has one input port. The number of output ports depends on the information that you select for probing, that is, signal dimensionality, sample time, and/or complex signal flag. Each probed value is output as a separate signal on a separate output port, with an independent data type control. During simulation, the block icon displays the probed data.

Ports

Input

expand all

Input signal to probe, specified as a scalar, vector, matrix, or N-D array. The block accepts real or complex-valued signals of any built-in data type.

You can use an array of buses as an input signal to a Probe block. For details about defining and using an array of buses, see Combine Buses into an Array of Buses.

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | Boolean | fixed point | enumerated | bus

Output

expand all

Width, or number of elements, in the input signal, specified as a scalar. The width is also displayed on the block icon with the notation W:.

Dependencies

To enable this port, select Probe width.

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | fixed point

Sample time of the input signal, as a two-element vector that specifies the period and offset of the sample time, respectively. The sample time is also displayed on the block icon with the notation Ts:. See Specify Sample Time for more information.

Dependencies

To enable this port, select Probe sample time.

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | fixed point

Indication of input signal complexity:

  • When the input signal is complex, the block outputs 1.

  • When the input signal is real-valued, the block outputs 0.

The indication of signal complexity is also displayed on the block icon with the notation C:.

Dependencies

To enable this port, select Detect complex signal.

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | fixed point

Dimensions of the input signal, output as a scalar or vector. The signal dimensions are also displayed on the block icon with the notation D:.

Dependencies

To enable this port, select Probe signal dimensions.

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | fixed point

Parameters

expand all

Main

Select to output the width, or number of elements, of the probed signal.

Programmatic Use

Block Parameter: ProbeWidth
Type: character vector
Values: 'off' | 'on'
Default: 'on'

Select to output the sample time of the probed signal. The output is a two-element vector that specifies the period and offset of the sample time, respectively. See Specify Sample Time for more information.

Programmatic Use

Block Parameter: ProbeSampleTime
Type: character vector
Values: 'off' | 'on'
Default: 'on'

Select to output 1 if the probed signal is complex; otherwise, 0.

Programmatic Use

Block Parameter: ProbeComplexSignal
Type: character vector
Values: 'off' | 'on'
Default: 'on'

Select to output the dimensions of the probed signal.

Programmatic Use

Block Parameter: ProbeSignalDimensions
Type: character vector
Values: 'off' | 'on'
Default: 'on'

Signal Attributes

Select the output data type for the signal width.

Programmatic Use

Block Parameter: ProbeWidthDataType
Type: character vector
Values: 'double' | 'single' | 'int8' | 'uint8' | 'int16' | 'uint16' | 'int32' | 'uint32' | 'Same as input'
Default: 'double'

Select the output data type for the sample time information.

Programmatic Use

Block Parameter: ProbeSampleTimeDataType
Type: character vector
Values: 'double' | 'single' | 'int8' | 'uint8' | 'int16' | 'uint16' | 'int32' | 'uint32' | 'Same as input'
Default: 'double'

Select the output data type for the complexity information.

Programmatic Use

Block Parameter: ProbeComplexityDataType
Type: character vector
Values: 'double' | 'single' | 'int8' | 'uint8' | 'int16' | 'uint16' | 'int32' | 'uint32' | 'Same as input'
Default: 'double'

Select the output data type for the signal dimension output.

Programmatic Use

Block Parameter: ProbeDimensionsDataType
Type: character vector
Values: 'double' | 'single' | 'int8' | 'uint8' | 'int16' | 'uint16' | 'int32' | 'uint32' | 'Same as input'
Default: 'double'

Block Characteristics

Data Types

Boolean | bus | double | enumerated | fixed point | integer | single | string

Direct Feedthrough

yes

Multidimensional Signals

yes

Variable-Size Signals

yes

Zero-Crossing Detection

no

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

Fixed-Point Conversion
Convert floating-point algorithms to fixed point using Fixed-Point Designer™.

Introduced before R2006a