Analyze Simulation Results

Use Simulation Data Inspector to explore data with custom visualizations, replay simulation results, and compare simulation data

You can use the Simulation Data Inspector to visualize, analyze, and compare logged simulation data or data imported from the workspace or a file. With the Simulation Data Inspector, you can:

Plot data using a variety of visualization options.
Analyze data with cursors or by replaying the simulation results.
Compare individual signals or simulation runs.

The Simulation Data Inspector supports both interactive and programmatic workflows. Use the functions and objects to programmatically manage signals and runs, compare data, and customize your visualizations. To learn more, see Simulation Data Inspector.

The Inspect pane of the Simulation Data Inspector shows three subplots. The subplots show time plots of data gathered from three runs of the model sldemo_autotrans. The first subplot shows the EngineRPM signals from all three runs. The second subplot shows the ShiftLogic signals from all three runs. The third subplot shows the VehicleSpeed signal from all three runs.

Tools

expand all

Simulation Data Inspector

Inspect and compare data and simulation results to validate and iterate model designs

Functions

expand all

Environment and Appearance

General

`Simulink.sdi.plot`	Plot data in Simulation Data Inspector
`Simulink.sdi.view`	Open the Simulation Data Inspector
`Simulink.sdi.close`	Close the Simulation Data Inspector
`Simulink.sdi.clearSubPlot`	Clear plotted signals from single subplot in Simulation Data Inspector (Since R2024b)
`Simulink.sdi.clearAllSubPlots`	Clear plotted signals from all subplots in the Simulation Data Inspector
`Simulink.sdi.snapshot`	Capture contents of Simulation Data Inspector plots
`Simulink.sdi.clearPreferences`	Restore Simulation Data Inspector preferences to default settings
`Simulink.sdi.saveView`	Save visualization settings to apply to other data (Since R2020a)
`Simulink.sdi.loadView`	Load a view file to visualize data in the Simulation Data Inspector
`Simulink.sdi.setUnitSystem`	Specify system of units to define signal display units in the Simulation Data Inspector (Since R2020b)
`Simulink.sdi.getUnitSystem`	Get current unit system configured in Simulation Data Inspector preferences (Since R2020b)
`Simulink.sdi.setRecordData`	Specify record mode for logging (Since R2021a)
`Simulink.sdi.getRecordData`	Check record mode for logging (Since R2021a)
`Simulink.sdi.setAppendRunToTop`	Specify order in which Simulation Data Inspector appends new run in work area or archive (Since R2022b)
`Simulink.sdi.getAppendRunToTop`	Get order in which Simulation Data Inspector appends run in work area or archive (Since R2022b)
`Simulink.sdi.setPosition`	Set position and size of Simulation Data Inspector (Since R2022b)
`Simulink.sdi.getPosition`	Get position and size of Simulation Data Inspector (Since R2022b)
`Simulink.sdi.setVisualization`	Set visualization type of subplot in Simulation Data Inspector (Since R2024b)
`Simulink.sdi.getVisualization`	Get visualization type of subplot in Simulation Data Inspector (Since R2024b)

Parallel Workflow Support

`Simulink.sdi.enablePCTSupport`	Control when to import data from parallel simulations into the Simulation Data Inspector
`Simulink.sdi.isPCTSupportEnabled`	Determine status and mode for Parallel Computing Toolbox support
`Simulink.sdi.sendWorkerRunToClient`	Send run created on parallel workers to the Simulation Data Inspector
`Simulink.sdi.cleanupWorkerResources`	Clean up worker repositories
`Simulink.sdi.WorkerRun.getLatest`	Create worker run for latest run

Customize Time Plot Appearance

`Simulink.sdi.getSubPlotLayout`	Get subplot layout in Simulation Data Inspector (Since R2023b)
`Simulink.sdi.setSubPlotLayout`	Set subplot layout in Simulation Data Inspector
`Simulink.sdi.setSubplotLimits`	Specify subplot limits for time plots in the Simulation Data Inspector (Since R2021a)
`Simulink.sdi.getSubplotLimits`	Get t- and y-axis limits for time plot in the Simulation Data Inspector (Since R2021a)
`Simulink.sdi.setTableGrouping`	Change signal grouping hierarchy in Inspect pane
`Simulink.sdi.getMarkersOn`	Determine if data markers are shown in the Simulation Data Inspector
`Simulink.sdi.setMarkersOn`	Show or hide markers for plotted signals
`Simulink.sdi.getGridOn`	Determine grid configuration for time plots
`Simulink.sdi.setGridOn`	Configure grid lines for time plots in the Simulation Data Inspector
`Simulink.sdi.getLegendPosition`	Get legend position in Simulation Data Inspector (Since R2023b)
`Simulink.sdi.setLegendPosition`	Set legend position in Simulation Data Inspector (Since R2023b)
`Simulink.sdi.getTicksPosition`	Get tick mark position setting for time plots
`Simulink.sdi.setTicksPosition`	Configure position for tick marks on time plots in the Simulation Data Inspector
`Simulink.sdi.getTickLabelsDisplay`	Get tick mark label setting for time plots
`Simulink.sdi.setTickLabelsDisplay`	Configure tick label visibility for time plot axes
`Simulink.sdi.getBorderOn`	Get border display setting for time plots
`Simulink.sdi.setBorderOn`	Display or hide border on time plots
`Simulink.sdi.getAutoTimespan`	Get behavior of time span in Simulation Data Inspector (Since R2022b)
`Simulink.sdi.setAutoTimespan`	Specify behavior of time span in Simulation Data Inspector (Since R2022b)

Control Cursors

`Simulink.sdi.setNumCursors`	Configure number of cursors active in Simulation Data Inspector (Since R2021a)
`Simulink.sdi.getNumCursors`	Check number of cursors active in the Simulation Data Inspector (Since R2021a)
`Simulink.sdi.setCursorPositions`	Specify active cursor positions in the Simulation Data Inspector (Since R2021a)
`Simulink.sdi.getCursorPositions`	Get position for active cursors in the Simulation Data Inspector (Since R2021a)
`Simulink.sdi.setCursorOptions`	Configure shading options for cursors in Simulation Data Inspector (Since R2020a)
`Simulink.sdi.getCursorOptions`	Get current shading options for cursors in Simulation Data Inspector (Since R2024a)
`Simulink.sdi.registerCursorCallback`	Register callback for cursor movements in the Simulation Data Inspector (Since R2021a)
`Simulink.sdi.unregisterCursorCallback`	Unregister cursor callback function (Since R2021a)

Compare

`Simulink.sdi.compareRuns`	Compare data in two simulation runs
`Simulink.sdi.compareSignals`	Compare data in two `Simulink.sdi.Signal` objects
`Simulink.sdi.getCurrentComparison`	Access results from most recent comparison (Since R2020a)
`Simulink.sdi.DiffRunResult.getLatest`	Access results from most recent comparison (Since R2020a)
`getResultByIndex`	Return signal comparison result
`getResultsByName`	Return signal comparison results based on signal name (Since R2022b)
`saveResult`	Save comparison results to an MLDATX file (Since R2020a)
`Simulink.sdi.getComparisonColor`	Get line color in comparison plot (Since R2021b)
`Simulink.sdi.setComparisonColor`	Set line color in comparison plot (Since R2021b)

Run Management

Create and Access Runs

`Simulink.sdi.Run.getLatest`	Get the most recently created Simulation Data Inspector run (Since R2020a)
`Simulink.sdi.getCurrentSimulationRun`	Access data for in-progress or most recently completed simulation (Since R2020a)
`Simulink.sdi.Run.create`	Import data into new run in Simulation Data Inspector and return `Simulink.sdi.Run` object
`Simulink.sdi.createRun`	Import data into new run in Simulation Data Inspector and return run ID
`Simulink.sdi.getRun`	Access data for a Simulation Data Inspector run
`Simulink.sdi.copyRun`	Copy a Simulation Data Inspector run
`Simulink.sdi.addToRun`	Import data into existing run in Simulation Data Inspector using run ID
`Simulink.sdi.deleteRun`	Delete a run from the Simulation Data Inspector repository
`Simulink.sdi.getRunCount`	Get number of runs in Simulation Data Inspector repository
`Simulink.sdi.getRunIDByIndex`	Use Simulation Data Inspector run index to get run ID
`Simulink.sdi.getAllRunIDs`	Get all Simulation Data Inspector run identifiers
`Simulink.sdi.isValidRunID`	Determine if run ID is valid
`Simulink.sdi.createRunOrAddToStreamedRun`	Create a single run for all simulation outputs

Run Object Functions

`add`	Import data into existing run in Simulation Data Inspector using `Simulink.sdi.Run` object
`getAllSignalIDs`	Get all signal IDs for signals in `Simulink.sdi.Run` object (Since R2020a)
`getAllSignals`	Get all signals in `Simulink.sdi.Run` object (Since R2020a)
`getDatasetRef`	Create a `Simulink.sdi.DatasetRef` object for a run
`getSignalByIndex`	Get signal in `Simulink.sdi.Run` object by index
`getSignalIDByIndex`	Get signal ID for signal at specified index in `Simulink.sdi.Run` object
`getSignalIDsByName`	Get signal IDs for signals inside `Simulink.sdi.Run` object using signal name (Since R2020a)
`getSignalsByName`	Access signals in a `Simulink.sdi.Run` object using signal name (Since R2020a)
`isValidSignalID`	Check whether signal ID corresponds to signal in `Simulink.sdi.Run` object

Run Management Settings

`Simulink.sdi.getRunNamingRule`	Get the Simulation Data Inspector rule for naming runs
`Simulink.sdi.setRunNamingRule`	Specify the Simulation Data Inspector run naming rule
`Simulink.sdi.resetRunNamingRule`	Revert the Simulation Data Inspector run naming rule to default
`Simulink.sdi.copyRunViewSettings`	Copy line style and color for signals from one run to another

Signal Management

Access Signals

`Simulink.sdi.getSignal`	Get Simulink.sdi.Signal object for a signal
`Simulink.sdi.deleteSignal`	Delete signal in the Simulation Data Inspector
`Simulink.sdi.markSignalForStreaming`	Turn logging on or off for signal
`Simulink.sdi.isValidSignalID`	Determine if signal ID is valid (Since R2022b)

Signal Object Functions

`collapse`	Represent multidimensional signal as a single signal with nonscalar sample values (Since R2021b)
`convertDataType`	Convert data type for signal in Simulation Data Inspector (Since R2022a)
`convertToFrames`	Remove buffering from frames of frame-based signal (Since R2021b)
`convertUnits`	Convert units of `Simulink.sdi.Signal` object
`expand`	Represent multidimensional signal as group of signals with scalar sample values (Since R2021b)
`export`	Export data for signal in Simulation Data Inspector to workspace or file
`getAsTall`	Create tall timetable from `Simulink.sdi.Signal` object
`plotOnSubPlot`	Plot `Simulink.sdi.Signal` object on Simulation Data Inspector subplot

Data Management

`Simulink.sdi.getArchiveRunLimit`	Get limit for number of runs to retain in Simulation Data Inspector archive
`Simulink.sdi.setArchiveRunLimit`	Specify number of runs to retain in Simulation Data Inspector archive
`Simulink.sdi.getAutoArchiveMode`	Get Simulation Data Inspector run management mode
`Simulink.sdi.setAutoArchiveMode`	Specify how Simulation Data Inspector manages simulation runs
`Simulink.sdi.load`	Load a Simulation Data Inspector session or view
`Simulink.sdi.clear`	Clear all data from the Simulation Data Inspector
`loadIntoMemory`	Load logged data into memory

Objects

expand all

Data Access

`Simulink.sdi.Run`	Access run signals and metadata
`Simulink.sdi.Signal`	Access signal data and metadata
`Simulink.SimulationData.Parameter`	Stores logged parameter data and metadata
`Simulink.sdi.DiffRunResult`	Access run comparison results
`Simulink.sdi.DiffSignalResult`	Access signal comparison results
`io.reader`	Base class used to define custom variable or file reader for Simulation Data Inspector (Since R2020b)
`Simulink.sdi.CustomSnapshot`	Specify settings for snapshot without opening or affecting the Simulation Data Inspector
`Simulink.sdi.WorkerRun`	Access simulation data from parallel workers
`Simulink.sdi.DatasetRef`	Access data in Simulation Data Inspector repository
`matlab.io.datastore.sdidatastore`	Datastore for Simulation Data Inspector signals
`Simulink.HMI.InstrumentedSignals`	Save and restore signal logging specification
`Simulink.HMI.SignalSpecification`	Programmatically connect a Dashboard block to a signal
`Simulink.sdi.constraints.MatchesSignal`	Constraint that compares time series data with tolerances using the Simulation Data Inspector
`Simulink.sdi.constraints.MatchesSignalOptions`	Specify comparison options for `Simulink.sdi.MatchesSignal` constraint

Topics

Visualize Simulation Results

Decide How to Visualize Simulation Data
Choose the right visualization technique for each modeling and simulation task.
View Simulation Data in Simulation Data Inspector
View logged simulation data alongside imported data and easily build complex visualizations using the Simulation Data Inspector.
Create Plots Using the Simulation Data Inspector
Create plots to analyze and present your data.
View Many Signals Together Using Sparklines
View many signals together on compact sparklines visualization.
View and Replay Map Data
View route of longitude and latitude data on map visualization.
Visualize Simulation Data on XY Plot
View and inspect simulation data using the XY visualization and replay controls in the Simulation Data Inspector.
View Multidimensional Signals Using the Array Plot
View and analyze multidimensional signal data using an array plot in the Simulation Data Inspector.
Configure the Simulation Data Inspector
Modify preferences in the Simulation Data Inspector to match your requirements.

Import Data into the Simulation Data Inspector

Import Data from Workspace or File into Simulation Data Inspector
You can import data into the Simulation Data inspector from the base workspace or from a file.
Microsoft Excel Import, Export, and Logging Format
Understand the Microsoft^® Excel^® file format used by the Simulation Data Inspector, the Record block, and Simulink^® Test™.
Import Data from a CSV File into the Simulation Data Inspector
Format data in a CSV file and import the file into the Simulation Data Inspector.
Import Data Using Custom File Reader
Write a custom file reader to import data from a file saved using a proprietary data or file format.
Import Workspace Variables Using a Custom Data Reader
Write a custom reader to import workspace data in a proprietary format.

Analyze Simulation Results

Inspect Simulation Data
View and inspect data from simulations or from imported data.
Analyze Data from Multiple Simulations
Use the Simulation Data Inspector to view results from multiple simulations side by side.
Replay Data in the Simulation Data Inspector
Replay data in the Simulation Data Inspector to inspect and analyze simulation behavior.
Analyze Multidimensional Signal Data
View and analyze multidimensional data in the Simulation Data Inspector and Record block as channels or a single signal with nonscalar sample values and choose whether to remove buffering from frame-based data.
Iterate Model Design Using the Simulation Data Inspector
View and manage data in the Simulation Data Inspector throughout an iterative design workflow.
Modify Signal Properties in the Simulation Data Inspector
Modify signal properties to analyze data and create new signals.
Inspect and Compare Data Programmatically
Programmatically plot and compare simulation data in the Simulation Data Inspector.
Synchronize Cursors in the Simulation Data Inspector with an App Designer App
Use the Simulation Data Inspector programmatic interface to synchronize data cursors in an App Designer app with cursors in the Simulation Data Inspector.

Compare Simulation Results

Compare Simulation Data
Compare signals or simulation runs.
How the Simulation Data Inspector Compares Data
The Simulation Data Inspector applies specified tolerances and signal alignment techniques when comparing runs.

Related Information

Featured Examples

Viewing Signals in Model Reference Instances

Model showing how to use the Simulation Data Inspector to view and analyze signals in referenced models.

Open Example

Analyze Data Using XY Plot

Analyze data in the Simulation Data Inspector using the XY visualization and trend lines.

Open Live Script