Simulink.sdi.Signal class

Пакет: Simulink.sdi

Доступ к данным сигнала и метаданным

Описание

Simulink.sdi.Signal объект обеспечивает доступ к данным сигнала и метаданным. Метаданные включают свойства для визуализации и сравнения сигналов.

Конструкция

signal = Simulink.sdi.getSignal(signalID) возвращает Simulink.sdi.Signal объект, соответствующий signalID.

signal = runObj.getSignal(signalID) возвращает Simulink.sdi.Signal объект, соответствующий signalID.

signal = runObj.getSignalByIndex(index) возвращает Simulink.sdi.Signal объект, соответствующий signalID в индексе, заданном index в Run объект runObj.

Входные параметры

развернуть все

Числовой идентификатор сигнала для сигнала сгенерирован Инспектором Данных моделирования. Можно получить ID сигнала для использования сигнала методы Simulink.sdi.Run объект или использование Simulink.sdi.getSignal функция.

Индекс сигнала в рамках запуска.

Пример 1

Свойства

развернуть все

Свойства сигнала

Уникальный номер, идентифицирующий сигнал. Инспектор Данных моделирования присваивает уникальный числовой ID каждому запуску и сигналу.

Запустите идентификатор для запуска, который содержит сигнал. Инспектор Данных моделирования присваивает уникальный числовой ID каждому запуску и сигналу. Можно получить доступ к ID запуска для сигнала с помощью Simulink.sdi.getAllRunIDs функция.

Имя сигнала.

Пример: 'fuel'

Описание сигнала, заданного как символьный массив или строка. Можно использовать Description свойство аннотировать сигнал или идентифицировать содержимое сигнала вне Name. Когда вы регистрируете данные Simscape™ Инспектору Данных моделирования, Description свойство заполняется автоматически для каждого узла.

Единицы измерения сигнала.

Пример: 'g/s'

Тип данных данных сигнала.

Пример: 'double'

Задает, являются ли данные сигнала действительными или комплексными.

Пример: 'real'

Шаг расчета сигнала. Значение 'Continuous' указывает на симуляцию переменного шага.

Пример: 'Continuous'

Пример: 0.1

Имя модели, которая произвела сигнал.

Пример: 'sldemo_fuelsys'

Путь к блоку, который произвел сигнал.

Пример: 'sldemo_fuelsys/Engine Gas Dynamics'

Путь к блоку, который генерирует сигнал включая полную иерархию модели. Для сигналов в эталонных моделях, FullBlockPath массив ячеек, содержащий полный путь. Для других сигналов, FullBlockPath идентично BlockPath.

Пример: 'sldemo_fuelsys/Engine Gas Dynamics/Mixing & Combustion/MinMax'

Индекс выходного порта, который задает сигнал.

Пример 1

Размерности матрицы, которая содержит сигнал.

Пример 1

Индексы сигнала для сигналов, которые являются частью вектора или матрицы.

Временные стоимости и значения данных для сигнала. Для шин, Values структура.

Имя высокоуровневой структуры логгирования, содержащей сигнал, для сигналов, импортируется из рабочего пространства MATLAB.

Имя переменной, содержащей данные времени сигнала для сигналов, импортируется из рабочего пространства MATLAB.

Имя массива, содержащего данные сигнала для сигналов, импортируется из рабочего пространства MATLAB.

Свойства визуализации

Сложный формат, задающий, как отобразить комплексные данные сигнала в Инспекторе Данных моделирования.

  • "real-imaginary" — Действительные и мнимые компоненты отображения сигнала вместе, когда вы строите сигнал. Мнимый компонент сигнала построен с различным оттенком Line Color.

  • "magnitude" — Величина сигнала отображается, когда вы строите сигнал.

  • "magnitude-phase" — Величина и фаза отображения сигнала вместе, когда вы строите сигнал.

  • "phase" — Фаза сигнала отображается, когда вы строите сигнал. Фаза построена с различным оттенком Line Color.

Типы данных: char | string

Логическое значение, указывающее, построен ли сигнал на каком-либо подграфике. Установка Checked к false очищает сигнал от всех подграфиков. Установка Checked к true строит сигнал на активном подграфике.

Типы данных: логический

Цвет сигнала в графиках, заданных как 1 3 вектор RGB.

Пример: [0 114 189]

Типы данных: double

Стиль сигнальной линии.

  • '-' задает стиль сплошной линии.

  • '--' задает стиль пунктирной линии.

  • ':' задает стиль точечной линии.

  • '-.' задает стиль штрихпунктирной линии.

Метод интерполяции используется в визуализации данных и синхронизации. 'zoh' указывает, что нулевой порядок содержит интерполяцию, 'linear' задает линейную интерполяцию и 'none' не задает интерполяции. Для получения дополнительной информации об опциях интерполяции, смотрите, Как Инспектор Данных моделирования Сравнивает Данные.

Свойства сравнения

Абсолютный допуск с положительным знаком сигнала используется в сравнениях сигнала. Инспектор Данных моделирования использует допуски, заданные в свойствах сигнала базового сигнала, когда Override Global Tol установлен в yes. Для получения дополнительной информации о допусках в Инспекторе Данных моделирования, смотрите, Как Инспектор Данных моделирования Сравнивает Данные.

Пример: 0.1

Типы данных: double

Относительный допуск с положительным знаком к сигналу используется в сравнениях сигнала. Инспектор Данных моделирования использует допуски, заданные в свойствах сигнала базового сигнала, когда Override Global Tol установлен в yes. Относительный допуск выражается как дробный множитель. Например, 0.1 задает 10-процентный допуск. Для получения дополнительной информации о допусках в Инспекторе Данных моделирования, смотрите, Как Инспектор Данных моделирования Сравнивает Данные.

Пример: 0.05

Типы данных: double

Допуск времени с положительным знаком к сигналу используется в сравнениях сигнала. Инспектор Данных моделирования использует допуски, заданные в свойствах сигнала базового сигнала, когда Override Global Tol установлен в yes. Задайте допуск времени в секундах. Для получения дополнительной информации о допусках в Инспекторе Данных моделирования, смотрите, Как Инспектор Данных моделирования Сравнивает Данные.

Пример: 0.1

Типы данных: double

Метод раньше синхронизировал данные времени сигнала для сравнения. Для получения дополнительной информации об опциях синхронизации, смотрите, Как Инспектор Данных моделирования Сравнивает Данные.

Методы

convertUnits Преобразуйте единицы сигнала
экспорт Экспортируйте объект сигнала в timeseries MATLAB
getAsTall Возвратите длинное расписание с временными стоимостями и значениями данных
plotOnSubPlot Сигнал графика на заданном подграфике

Копировать семантику

Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Примеры

свернуть все

Можно изменить значения допуска на основе сигнала сигналом, чтобы оценить эффект изменения параметра модели. Этот пример использует slexAircraftExample модель и Инспектор Данных моделирования, чтобы оценить эффект изменения постоянной времени для фильтра lowpass после входа управления.

Настройка

Загрузите модель и отметьте q, rad/sec и alpha, rad сигналы для логгирования. Затем симулируйте модель, чтобы создать базовый запуск.

% Load example model
load_system('slexAircraftExample')

% Mark the q, rad/sec and alpha, rad signals for logging
Simulink.sdi.markSignalForStreaming('slexAircraftExample/Aircraft Dynamics Model',3,'on')
Simulink.sdi.markSignalForStreaming('slexAircraftExample/Aircraft Dynamics Model',4,'on')

% Simulate system
out_1 = sim('slexAircraftExample');

Измените параметр модели

Измените параметр модели Ts в рабочем пространстве модели, чтобы изменить постоянную времени входа фильтр lowpass.

% Change input filter time constant
modelWorkspace = get_param('slexAircraftExample','modelworkspace');
assignin(modelWorkspace,'Ts',1)

% Simulate again
out_2 = sim('slexAircraftExample');

Сравните запуски и смотрите результаты

Используйте Simulink.sdi.compareRuns функция, чтобы сравнить данные из симуляций. Затем смотрите match свойство результата сигнала видеть, находились ли сигналы в пределах допуска по умолчанию 0.

% Get run data
runIDs = Simulink.sdi.getAllRunIDs;
runID1 = runIDs(end - 1);
runID2 = runIDs(end);

% Compare runs
diffRun1 = Simulink.sdi.compareRuns(runID1,runID2);

% Get signal result
sig1Result1 = getResultByIndex(diffRun1,1);
sig2Result1 = getResultByIndex(diffRun1,2);

% Check whether signals matched
sig1Result1.Status
ans = 
OutOfTolerance
sig2Result1.Status
ans = 
OutOfTolerance

Сравните запуски с допусками сигнала

Сигналы не соответствовали в допуске по умолчанию 0. Чтобы далее анализировать эффект изменения постоянной времени, добавьте допуски сигнала в сравнение с базовыми свойствами сигнала определить допуск, требуемый для передачи. Этот пример использует комбинацию времени и абсолютных допусков.

% Get signal object for sigID1
run1 = Simulink.sdi.getRun(runID1);
sigID1 = getSignalIDByIndex(run1,1);
sigID2 = getSignalIDByIndex(run1,2);

sig1 = Simulink.sdi.getSignal(sigID1);
sig2 = Simulink.sdi.getSignal(sigID2);

% Set tolerances for q, rad/sec
sig1.AbsTol = 0.1;
sig1.TimeTol = 0.6;

% Set tolerances for alpha, rad
sig2.AbsTol = 0.2;
sig2.TimeTol = 0.8;

% Run the comparison again
diffRun2 = Simulink.sdi.compareRuns(runID1,runID2);
sig1Result2 = getResultByIndex(diffRun2,1);
sig2Result2 = getResultByIndex(diffRun2,2);

% Check the result
sig1Result2.Status
ans = 
WithinTolerance
sig2Result2.Status
ans = 
WithinTolerance

В этом примере показано, как получить Simulink.sdi.Signal возразите и измените его свойства с помощью Инспектора Данных моделирования программируемый интерфейс.

Получите Simulink.sdi.Signal Объект

Во-первых, запустите симуляцию, чтобы создать запуск. Этот пример использует модель slexAircraftExample в качестве примера. Затем используйте Инспектора Данных моделирования программируемый интерфейс, чтобы получить Simulink.sdi.Signal возразите для своего сигнала интереса.

% Configure model "slexAircraftExample" for logging and simulate
simOut = sim('slexAircraftExample','SaveOutput','on',...
                   'SaveFormat','StructureWithTime');
 
% Use Simulink.sdi.createRun to create a run and return the list of signal IDs for signals 
% contained in the run
[~,~,signalIDs] = Simulink.sdi.createRun('My Run','base',{'simOut'});

% Get the signal object corresponding to the first signal ID
signalObj = Simulink.sdi.getSignal(signalIDs(1));

Измените свойства сигнала

Simulink.sdi.Signal объект имеет несколько сравнений и свойств визуализации, которые можно изменить.

% Define comparison and visualization properties for this signal
signalObj.syncMethod = 'intersection';
signalObj.lineColor = [1,0.4,0.6];
signalObj.lineDashed = '-';
signalObj.checked = true;

Просмотрите свойства сигнала

Можно просмотреть свойства сигнала в командном окне и в Инспекторе Данных моделирования, чтобы проверить, что сигналу задали его свойства, как вы хотите их.

signalObj
signalObj = 
  Signal with properties:

               ID: 18481
            RunID: 18467
             Name: 'Integrate:CSTATE'
      Description: ""
            Units: ''
         DataType: 'double'
       Complexity: "real"
    ComplexFormat: "real-imaginary"
       SampleTime: ''
            Model: 'slexAircraftExample'
        BlockPath: 'slexAircraftExample/Aircraft Dynamics Model/Vertical Channel/Integrate'
    FullBlockPath: 'slexAircraftExample/Aircraft Dynamics Model/Vertical Channel/Integrate'
        PortIndex: 0
       Dimensions: 1
          Channel: [1x0 int32]
          Checked: 1
        LineColor: [1 0.4000 0.6000]
       LineDashed: '-'
     InterpMethod: 'linear'
           AbsTol: 0
           RelTol: 0
          TimeTol: 0
       SyncMethod: 'intersection'
           Values: [1x1 timeseries]
       RootSource: 'simOut.get('xout')'
       TimeSource: 'simOut.get('xout').time'
       DataSource: 'simOut.get('xout').signals(1).values'

Simulink.sdi.view

Этот пример использует slexAircraftExample модель, чтобы продемонстрировать сравнение ввода и вывода сигнализирует для системы управления. Пример отмечает сигналы для потоковой передачи, затем получает объект запуска для запущенной симуляции. Идентификаторы сигнала от объекта запуска задают сигналы, которые будут сравнены.

% Load model slexAircraftExample and mark signals for streaming
load_system('slexAircraftExample')
Simulink.sdi.markSignalForStreaming('slexAircraftExample/Pilot',1,'on')
Simulink.sdi.markSignalForStreaming('slexAircraftExample/Aircraft Dynamics Model',4,'on')

% Simulate model slexAircraftExample
out = sim('slexAircraftExample');

% Get run IDs for most recent run
allIDs = Simulink.sdi.getAllRunIDs;
runID = allIDs(end);

% Get Run object
aircraftRun = Simulink.sdi.getRun(runID);

% Get signal IDs
signalID1 = getSignalIDByIndex(aircraftRun,1);
signalID2 = getSignalIDByIndex(aircraftRun,2);

if (isValidSignalID(aircraftRun,signalID1))
    % Change signal tolerance
    signal1 = Simulink.sdi.getSignal(signalID1);
    signal1.AbsTol = 0.1;
end

if (isValidSignalID(aircraftRun,signalID1) && isValidSignalID(aircraftRun,signalID2))
    % Compare signals
    sigDiff = Simulink.sdi.compareSignals(signalID1,signalID2);

    % Check whether signal result status
    match = sigDiff.Status
end
match = 
OutOfTolerance

Этот пример демонстрирует, как получить доступ к Simulink.sdi.Run объект для Инспектора Данных моделирования, запущенного созданный путем логгирования сигналов. От Simulink.sdi.Run объект можно получить Simulink.sdi.Signal объекты, которые можно использовать, чтобы отобразить данные на графике.

Создайте запущенную симуляцию и доступ к Run Объект

sldemo_fuelsys модель включает несколько сигналов, которые отмечены для логгирования. Чтобы создать симуляцию, запущенную содержащий записанные данные, симулируйте модель.

sim('ex_vdp');

Инспектор Данных моделирования отслеживает запуски путем присвоения каждого запуска, созданного симуляцией, импортирования данных или открытия сеанса уникальный числовой ID. Чтобы получить доступ к объекту запуска для симуляции, только выполненной, используйте Simulink.sdi.getAllRunIDs функционируйте и возьмите последний ID запуска в возвращенном векторе.

runIDs = Simulink.sdi.getAllRunIDs;
runID = runIDs(end);

Если у вас есть ID запуска для запуска интереса, можно использовать Simulink.sdi.getRun функция, чтобы получить Simulink.sdi.Run объект, соответствующий запуску. Можно использовать Run возразите, чтобы проверять метаданные, сопоставленные с запуском, включая количество сигналов в запуске.

vdpRun = Simulink.sdi.getRun(runID);

vdpRun.SignalCount
ans = int32
    2

Отобразите данные на графике Используя Signal Объекты

Используйте getSignalByIndex функционируйте, чтобы получить доступ к сигналам интереса от Run объект, fuelRun.

signal1 = getSignalByIndex(vdpRun,1);
signal2 = getSignalByIndex(vdpRun,2);

Используйте Simulink.sdi.setSubPlotLayout функция, чтобы задать размещение 3 на 1.

Simulink.sdi.setSubPlotLayout(2,1)

Прежде, чем отобразить данные на графике, используйте Simulink.sdi.clearAllSubPlots функционируйте, чтобы очистить любые данные, которые уже отображены на графике.

Simulink.sdi.clearAllSubPlots

Постройте один сигнал на каждом подграфике. Чтобы построить сигналы на первом подграфике, можно установить checked свойство для сигнала. Чтобы построить сигналы на подграфиках кроме первого подграфика, используйте plotOnSubPlot функция.

signal1.Checked = true;
plotOnSubPlot(signal2,2,1,true);

Просмотрите отображенные на графике данные

Чтобы просмотреть графики, вы только создали, откройте Инспектора Данных моделирования, использующего Simulink.sdi.view функция.

Альтернативы

Используйте Инспектора Данных моделирования пользовательский интерфейс, чтобы просмотреть и изменить сигналы и свойства сигнала.

Представленный в R2012b

Для просмотра документации необходимо авторизоваться на сайте