gettsbeforeevent

イベント前の timeseries の作成

構文

tsout = gettsbeforeevent(tsin,tsevent)

tsout = gettsbeforeevent(tsin,tsevent,n)

説明

tsout = gettsbeforeevent(tsin,tsevent) は、入力 timeseries tsin 内でイベント tsevent の前にサンプルが発生する timeseries オブジェクトを返します。引数 tsevent には tsdata.event オブジェクトまたはイベントの名前を含む文字ベクトルを指定できます。tsevent が tsdata.event オブジェクトの場合、tsevent で定義される時間で時間を指定します。tsevent が文字ベクトルの場合、イベント名に一致する tsin の Events プロパティ内の最初の tsdata.event オブジェクトで時間を指定します。

tsout = gettsbeforeevent(tsin,tsevent,n) は、tsin のイベント前にサンプルが発生する timeseries オブジェクトを返します。ここで、n はイベント tsevent のイベント発生回数です。

例

すべて折りたたむ

イベント前の `timeseries`

ライブスクリプトを開く

時間サンプル 2 にイベントが発生する timeseries オブジェクトを作成します。

tsin = timeseries((1:5)');
tsevent = tsdata.event('MyEvent',2);
tsin = addevent(tsin,tsevent);
tsin.Events

    EventData: []
         Name: 'MyEvent'
         Time: 2
        Units: 'seconds'
    StartDate: ''

イベントサンプル前のデータを含む新しい timeseries オブジェクトを作成します。

tsout = gettsbeforeevent(tsin,'MyEvent');
tsout.Time

ans = 2×1

     0
     1

入力引数

すべて折りたたむ

`tsin` — 入力 `timeseries`
スカラー

入力 timeseries。スカラーとして指定します。

データ型: timeseries

`tsevent` — イベント
スカラー | 文字ベクトル

イベント。スカラー tsdata.event オブジェクトまたはイベントの名前を含む文字ベクトルとして指定します。

`n` — イベント番号
スカラー整数

イベント回数。timeseries オブジェクトの n 番目の tsdata.event を表すスカラー整数として指定します。

ヒント

入力 timeseries オブジェクト tsin に日付文字ベクトルが含まれ、tsevent が数値の時間を使用する場合、tsevent によって選択される時間は tsin.TimeInfo 内の StartDate プロパティを基準にして計算された日付として扱われます。
tsin が数値の時間を使用し、tsevent がカレンダー日付を使用する場合、tsevent によって選択された時間は、カレンダー日付には関連付けされていない数値として扱われます。