Main Content

Analyze Simulation Results

Inspect data using cursors and custom visualizations, replay simulation results, compare simulation data

You can use the Simulation Data Inspector to inspect and compare data from multiple simulations. For example, you can check to see if the difference between two signals is within a certain design tolerance. To learn more, see Simulation Data Inspector.

Tools

expand all

Simulation Data InspectorInspect and compare data and simulation results to validate and iterate model designs

Functions

expand all

General

Simulink.sdi.viewOpen the Simulation Data Inspector
Simulink.sdi.closeClose the Simulation Data Inspector
Simulink.sdi.clearAllSubPlotsClear plotted signals from all subplots in the Simulation Data Inspector
Simulink.sdi.snapshotCapture contents of Simulation Data Inspector plots
Simulink.sdi.clearPreferencesRestore Simulation Data Inspector preferences to default settings
Simulink.sdi.saveViewSave visualization settings to apply to other data
Simulink.sdi.loadViewLoad a view file to visualize data in the Simulation Data Inspector
Simulink.sdi.setUnitSystemSpecify system of units to define signal display units in the Simulation Data Inspector
Simulink.sdi.getUnitSystemGet current unit system configured in Simulation Data Inspector preferences
Simulink.sdi.setRecordDataSpecify record mode for logging
Simulink.sdi.getRecordDataCheck record mode for logging

Parallel Workflow Support

Simulink.sdi.enablePCTSupportControl when to import data from parallel simulations into the Simulation Data Inspector
Simulink.sdi.isPCTSupportEnabledDetermine status and mode for Parallel Computing Toolbox support
Simulink.sdi.sendWorkerRunToClientSend run created on parallel workers to the Simulation Data Inspector
Simulink.sdi.cleanupWorkerResourcesClean up worker repositories

Customize Time Plot Appearance

Simulink.sdi.setSubPlotLayoutSet subplot layout in the Simulation Data Inspector
Simulink.sdi.setSubplotLimitsSpecify subplot limits for time plots in the Simulation Data Inspector
Simulink.sdi.getSubplotLimitsGet t- and y-axis limits for time plot in the Simulation Data Inspector
Simulink.sdi.setTableGroupingChange signal grouping hierarchy in Inspect pane
Simulink.sdi.getMarkersOnDetermine if data markers are shown in the Simulation Data Inspector
Simulink.sdi.setMarkersOnShow or hide markers for plotted signals
Simulink.sdi.getGridOnDetermine grid configuration for time plots
Simulink.sdi.setGridOnConfigure grid lines for time plots in the Simulation Data Inspector
Simulink.sdi.getTicksPositionGet tick mark position setting for time plots
Simulink.sdi.setTicksPositionConfigure position for tick marks on time plots in the Simulation Data Inspector
Simulink.sdi.getTickLabelsDisplayGet tick mark label setting for time plots
Simulink.sdi.setTickLabelsDisplayConfigure tick label visibility for time plot axes
Simulink.sdi.getBorderOnGet border display setting for time plots
Simulink.sdi.setBorderOnDisplay or hide border on time plots

Control Cursors

Simulink.sdi.setNumCursorsConfigure number of cursors active in Simulation Data Inspector
Simulink.sdi.getNumCursorsCheck number of cursors active in the Simulation Data Inspector
Simulink.sdi.setCursorPositionsSpecify active cursor positions in the Simulation Data Inspector
Simulink.sdi.getCursorPositionsGet position for active cursors in the Simulation Data Inspector
Simulink.sdi.setCursorOptionsConfigure shading options for cursors in the Simulation Data Inspector
Simulink.sdi.registerCursorCallbackRegister callback for cursor movements in the Simulation Data Inspector
Simulink.sdi.unregisterCursorCallbackUnregister cursor callback function
Simulink.sdi.compareRunsCompare data in two simulation runs
Simulink.sdi.compareSignalsCompare data in two Simulink.sdi.Signal objects
Simulink.sdi.getCurrentComparisonAccess results from most recent comparison
Simulink.sdi.DiffRunResult.getLatestAccess results from most recent comparison
getResultByIndexReturn signal comparison result
saveResultSave comparison results to an MLDATX file

Create and Access Runs

Simulink.sdi.Run.getLatestGet the most recently created Simulation Data Inspector run
Simulink.sdi.getCurrentSimulationRunAccess data for in-progress or most recently completed simulation
Simulink.sdi.Run.createImport data into a run in the Simulation Data Inspector
Simulink.sdi.createRunImport data into the Simulation Data Inspector
Simulink.sdi.getRunAccess data for a Simulation Data Inspector run
Simulink.sdi.copyRunCopy a Simulation Data Inspector run
Simulink.sdi.addToRunAdd one or more signals to existing run
Simulink.sdi.deleteRunDelete a run from the Simulation Data Inspector repository
Simulink.sdi.getRunCountGet number of runs in Simulation Data Inspector repository
Simulink.sdi.getRunIDByIndexUse Simulation Data Inspector run index to get run ID
Simulink.sdi.getAllRunIDsGet all Simulation Data Inspector run identifiers
Simulink.sdi.isValidRunIDDetermine whether a run ID is valid
Simulink.sdi.createRunOrAddToStreamedRunCreate a single run for all simulation outputs

Run Object Functions

addAdd signals to Simulink.sdi.Run object
getAllSignalIDsGet all signal IDs for signals in Simulink.sdi.Run object
getAllSignalsGet all signals in Simulink.sdi.Run object
getDatasetRefCreate a Simulink.sdi.DatasetRef object for a run
getSignalByIndexGet signal in Simulink.sdi.Run object by index
getSignalIDByIndexGet signal ID for signal at specified index in Simulink.sdi.Run object
getSignalIDsByNameGet signal IDs for signals inside Simulink.sdi.Run object using signal name
getSignalsByNameAccess signals in a Simulink.sdi.Run object using signal name
isValidSignalIDCheck whether signal ID corresponds to signal in Simulink.sdi.Run object

Run Management Settings

Simulink.sdi.getRunNamingRuleGet the Simulation Data Inspector rule for naming runs
Simulink.sdi.setRunNamingRuleSpecify the Simulation Data Inspector run naming rule
Simulink.sdi.resetRunNamingRuleRevert the Simulation Data Inspector run naming rule to default
Simulink.sdi.copyRunViewSettingsCopy line style and color for signals from one run to another

Access Signals

Simulink.sdi.getSignalGet Simulink.sdi.Signal object for a signal
Simulink.sdi.deleteSignalDelete signal in the Simulation Data Inspector
Simulink.sdi.markSignalForStreamingTurn logging on or off for a signal

Signal Object Functions

collapseRepresent multidimensional signal as a single signal with nonscalar sample values
convertToFramesRemove buffering from frames of frame-based signal
convertUnits Convert units of Simulink.sdi.Signal object
expandRepresent multidimensional signal as group of signals with scalar sample values
export Export Simulink.sdi.Signal object to workspace or file
getAsTall Create tall timetable from Simulink.sdi.Signal object
plotOnSubPlot Plot Simulink.sdi.Signal object on Simulation Data Inspector subplot
Simulink.sdi.getArchiveRunLimitDetermine configured run limit for Simulation Data Inspector archive
Simulink.sdi.setArchiveRunLimitSpecify a limit for the number of runs stored in the Simulation Data Inspector archive
Simulink.sdi.getAutoArchiveModeDetermine if the Simulation Data Inspector is configured to automatically archive
Simulink.sdi.setAutoArchiveModeSpecify whether the Simulation Data Inspector automatically archives simulation runs
Simulink.sdi.loadLoad a Simulation Data Inspector session or view
Simulink.sdi.clearClear all data from the Simulation Data Inspector
loadIntoMemoryLoad logged data into memory

Classes

expand all

Simulink.sdi.RunAccess run signals and metadata
Simulink.sdi.Signal Access signal data and metadata
Simulink.SimulationData.ParameterStores logged parameter data and metadata
Simulink.sdi.DiffRunResultAccess run comparison results
Simulink.sdi.DiffSignalResultAccess signal comparison results
io.readerBase class used to define custom variable or file reader for Simulation Data Inspector
Simulink.sdi.CustomSnapshot Specify settings for a snapshot without opening or affecting the Simulation Data Inspector
Simulink.sdi.WorkerRun Access simulation data from parallel workers
Simulink.sdi.DatasetRefAccess data in Simulation Data Inspector repository
matlab.io.datastore.sdidatastore Datastore for Simulation Data Inspector signals
Simulink.HMI.InstrumentedSignalsSave and restore signal logging specification
Simulink.HMI.SignalSpecificationProgrammatically connect a Dashboard block to a signal
Simulink.sdi.constraints.MatchesSignalConstraint that compares time series data with tolerances using the Simulation Data Inspector
Simulink.sdi.constraints.MatchesSignalOptionsSpecify 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 Data in the 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

You can add a map to your layout in the Simulation Data Inspector to view routes of longitude and latitude data.

Visualize Simulation Data on an 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

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 a 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.

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.

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

Use the Simulation Data Inspector API to plot and compare simulation data.

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.

Featured Examples