Simulink.sdi.setUnitSystem

R2026b

Specify system of units to define signal display units in the Simulation Data Inspector

collapse all in page

    Syntax

    Simulink.sdi.setUnitSystem(Name=Value)

    Description

    Simulink.sdi.setUnitSystem(Name=Value) configures the units displayed in the Simulation Data Inspector for logged and imported signals using one or more name-value arguments.

    The Simulation Data Inspector plots signals using the display units. The display units for a signal may differ from the stored units, which indicate units for the data as stored on disk. When you specify a system of display units or override display units for a particular measurement, the Simulation Data Inspector automatically adjusts the display units for logged or imported signals that use units that are not valid in the specified system.

    example

    Examples

    collapse all

    Open Live Script

    To specify a system of units to use for plotting signals in the Simulation Data Inspector, use the Simulink.sdi.setUnitSystem function. When you choose to display signals using the International System of Units or US Customary unit system, the Simulation Data Inspector automatically changes the Display Units property for logged or imported signals that use units that are not part of the specified unit system. The signal data stored on disk does not change. Signals also have a Stored Units property, and the Simulation Data Inspector converts the data to plot the signal when the Stored Units and Display Units differ.

    Specify a System of Units

    By default, the Simulation Data Inspector displays signals using the units assigned to the signal during simulation or in the imported data. To facilitate analyzing multiple signals and data sets together, you can specify a system of units as a preference. The Simulation Data Inspector automatically updates the Display Units for logged or imported signals that use units that are invalid in the specified unit system. For example, a signal logged in a model using units of feet could be updated to use units of meters when the system of units is specified as "SI".

    Use the Simulink.sdi.setUnitSystem function to configure the Simulation Data Inspector to display signals using units in the US Customary unit system.

    Simulink.sdi.setUnitSystem("USCustomary");

    Specify Override Units

    When you want all signals that represent the same type of measurement to use the same Display Units, you can also specify override units. For example, to plot all signals that represent length using units of meters, specify "m" as an override unit.

    Simulink.sdi.setUnitSystem("USCustomary","Overrides","m");

    Check Unit Configuration

    Use the Simulink.sdi.getUnitSystem function to check the current unit preferences configured in the Simulation Data Inspector.

    [unitSystem,overrideUnits] = Simulink.sdi.getUnitSystem
    unitSystem = 
'USCustomary'

    overrideUnits = 
"m"

    Name-Value Arguments

    collapse all

    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.

    Example: Simulink.sdi.setUnitSystem(Overrides="m")

    System of units used to define signal display units, specified as "Default", "SI", or "USCustomary".

    • "Default" — Use units as stored on disk for signal display.

    • "SI" — Use units from the SI unit system for signal display.

    • "USCustomary" — Use units from the US Customary unit system for signal display.

    Example: System="SI"

    Units to override signal display units, specified as a string or string array. Specify override units when you want all signals that represent the same measurement type to use consistent units. For example, specify override units of feet to display all signals that represent length measurements using units of "ft".

    Example: Overrides=["in","lb"]

    Version History

    Introduced in R2020b

    expand all

    See Also

    Objects

    Functions

    Topics