timeseries

timeseries オブジェクトの作成

説明

時系列は、集団の動態や過程の時間発展を表します。これらは離散的な時間間隔でサンプリングされたデータ内のパターンおよび動作の識別、モデル化、および予測に使用されます。

メモ

timetable は timeseries よりも推奨されます。timetable では、さまざまな型のタイムスタンプ付きデータを格納することができ、前処理、再構成、解析用の幅広い一連のサポート関数が用意されています。

timeseries データ型を削除する予定はありません。

作成

timeseries オブジェクトを作成するには、関数 timeseries を、データ サンプルを表す入力引数を指定して使用します。

構文

ts = timeseries(datavals)

ts = timeseries(datavals,timevals)

ts = timeseries(datavals,timevals,quality)

ts = timeseries(___,'Name',tsname)

ts = timeseries()

ts = timeseries(tsname)

説明

ts = timeseries(datavals) は、datavals のデータを含む timeseries オブジェクトを返します。1 秒のタイム ステップで、ゼロ秒から開始する既定のサンプル時間を割り当てます。

ts = timeseries(datavals,timevals) は系列のサンプル時間を指定します。結果として得られるオブジェクトはデータを時間で並べ替えます。

ts = timeseries(datavals,timevals,quality) は、QualityInfo.Code で定義されたコードについての特性の説明を指定します。

ts = timeseries(___,'Name',tsname) は、timeseries オブジェクトの名前 tsname を指定します。

ts = timeseries() は、空の timeseries オブジェクトを返します。

ts = timeseries(tsname) は、名前が tsname である空の timeseries オブジェクトを作成します。

入力引数

datavals — サンプル データ

スカラー | ベクトル | 多次元配列

サンプル データ。数値または logical スカラー、ベクトル、または多次元配列として指定します。

データ型: double | single | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

timevals — サンプル時間

スカラー | ベクトル

サンプル時間。数値スカラーまたは数値ベクトル、あるいは日付文字ベクトルの cell 配列として指定します。有効な日付文字ベクトルは、次の形式で表すことができます。

形式	例
dd-mmm-yyyy HH:MM:SS	01-Mar-2000 15:45:17
dd-mmm-yyyy	01-Mar-2000
mm/dd/yy	03/01/00
mm/dd	03/01
HH:MM:SS	15:45:17
HH:MM:SS PM	3:45:17 PM
HH:MM	15:45
HH:MM PM	3:45 PM
mmm.dd,yyyy HH:MM:SS	Mar.01,2000 15:45:17
mmm.dd,yyyy	Mar.01,2000
mm/dd/yyyy	03/01/2000

データ型: double | single | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | cell

quality — 特性コード

[] (既定値) | スカラー | ベクトル | 多次元配列

特性コード。[] または -128 ～ 127 の範囲の整数のスカラー、ベクトル、または多次元配列として指定します。

• 特性コードの値がベクトルの場合は、時間ベクトルと同じ長さでなければなりません。各要素は、対応するデータ サンプリングに適用されます。

• 特性コードの値が配列の場合は、データ配列と同じサイズでなければなりません。各要素は、データ配列の対応する要素に適用されます。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

tsname — timeseries の名前

文字ベクトル

timeseries の名前。文字ベクトルとして指定します。

プロパティ

Data — サンプル データ

スカラー | ベクトル | 多次元配列

サンプル データ。数値または logical スカラー、ベクトル、または多次元配列として表されます。データの最初の次元か最後の次元のいずれかが、時間ベクトルの方向と一致していなければなりません。

Data には、以下の属性があります。

Dependent

true

データ型: double | single | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

DataInfo — データ情報

フィールドの集合

データ情報。次のフィールドの集合として表されます。

• Units — データ単位を指定する文字ベクトル。

• Interpolation — 内挿法を指定する tsdata.interpolation オブジェクト。

  tsdata.interpolation オブジェクトのフィールドは、以下を含みます。

  • Fhandle — ユーザー定義の内挿関数の関数ハンドル。

  • Name — 内挿法の名前を指定する文字ベクトル。線形内挿の場合は 'linear' (既定)、ゼロ次ホールドの場合は 'zoh' などの方法があります。

• UserData — 追加のユーザー定義情報。文字ベクトルとして入力します。

Events — イベント情報

tsdata.event オブジェクトの配列

イベント情報。イベント情報を含む tsdata.event オブジェクトの配列として表されます。

tsdata.event オブジェクトのフィールドは、以下を含みます。

• EventData — イベントに関する追加のユーザー定義の情報。

• Name — イベントの名前を指定する文字ベクトル。

• Time — イベントが発生する時間。実数または日付文字ベクトルとして指定します。

• Units — 時間の単位。

• StartDate — 基準日。日付文字ベクトルとして指定します。時間ベクトルが数値の場合、StartDate は空となります。

IsTimeFirst — 時間ベクトルの配置

true | false

時間ベクトルの配置。次のいずれかのオプションとして表されます。

• true — データ配列の最初の次元が、時間ベクトルに合わせて割り当てられます。例: ts = timeseries(rand(3,3),1:3);

• false — データ配列の最後の次元が、時間ベクトルに合わせて割り当てられます。例: ts = timeseries(rand(3,4,5),1:5);

IsTimeFirst には、以下の属性があります。

Dependent	true
SetAccess	'protected'

Length — 時間ベクトルの長さ

スカラー

時間ベクトルの長さ。スカラーとして表されます。

Length には、以下の属性があります。

Dependent	true
SetAccess	'protected'

Name — timeseries の名前

文字ベクトル

timeseries の名前。文字ベクトルとして表されます。

Quality — 特性コード

[] (既定値) | スカラー | ベクトル | 多次元配列

特性コード。[] または -128 ～ 127 の範囲の整数のスカラー、ベクトル、または多次元配列として表されます。

• 特性コードの値がベクトルの場合は、時間ベクトルと同じ長さでなければなりません。各要素は、対応するデータ サンプリングに適用されます。

• 特性コードの値が配列の場合は、データ配列と同じサイズでなければなりません。各要素は、データ配列の対応する要素に適用されます。

Quality には、以下の属性があります。

Dependent

true

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

QualityInfo — 特性情報

フィールドの集合

Quality コードを記述するための特性情報。以下のフィールドの集合として表されます。

• Code — 特性コードを定義する、-128 から 127 の値をもつ整数ベクトル。Quality プロパティを使用すると、これらの整数値のいずれかを各 Data 値に割り当てることができます。

• Description — 文字ベクトルの cell 配列。各要素は、関連する特性 Code の読み取り可能な記述を示します。

• UserData — 追加のユーザー定義情報。

Code と Description の長さは、一致しなければなりません。

Time — 時間値

ベクトル

時間値。ベクトルとして表されます。

TimeInfo.StartDate が空の場合、値は 0 と比較して計算されます。TimeInfo.StartDate が定義された場合、値は StartDate と比較して計算された日付文字ベクトルを示します。

Time の長さは、Data の最初または最後の次元と同じでなければなりません。

Time には、以下の属性があります。

Dependent

true

TimeInfo — 時間情報

フィールドの集合

時間情報。時間ベクトルを記述する次のフィールドの集合として表されます。

• Units — 値 'weeks'、'days'、'hours'、'minutes'、'seconds'、'milliseconds'、'microseconds'、または 'nanoseconds' をもつ時間単位。

• Start — 開始時間。

• End — 終了時間 (読み取り専用)。

• Increment — 後続の時間値の間隔 (時間が等間隔にサンプリングされていない場合は NaN)。

• Length — 時間ベクトルの長さ (読み取り専用)。

• Format — 日付表示を定義する文字ベクトル (datestr を参照)。

• StartDate — 基準日を定義する日付文字ベクトル (setabstime を参照)。Format と同じ形式を使用して StartDate を指定します。

• UserData — 追加のユーザー定義情報。

フィールドの値にアクセスするには、timeseries オブジェクト ts の ts.TimeInfo.field の形式を使用します。

TreatNaNasMissing — 欠損値インジケーター

true (既定値) | false

欠損値インジケーター。次のオプションのいずれかとして表されます。

• true — すべての NaN 値を欠損データとして扱います。ただし、記述統計関数を除きます。

• false — NaN 値を記述統計関数に含め、NaN を結果に伝播させます。

UserData — ユーザー データ

[] (既定値)

ユーザー データ。timeseries オブジェクトに追加する任意のデータとして表されます。

オブジェクト関数

変更とプロット

addevent	timeseries へのイベントの追加
addsample	データ サンプルを timeseries オブジェクトに追加
append	timeseries オブジェクトを時間順に連結
delevent	timeseries からイベントを削除
delsample	timeseries オブジェクトからサンプルを削除
detrend	timeseries オブジェクトからの平均値または最適な近似の減算
filter	timeseries オブジェクトの周波数成分の変更
idealfilter	timeseries の理想フィルター
plot	timeseries のプロット
resample	timeseries または tscollection の時間ベクトルをリサンプリングする
setabstime	timeseries または tscollection の時間を日付文字ベクトルとして設定する
setinterpmethod	timeseries オブジェクトに既定の内挿法を設定
setuniformtime	timeseries の等間隔時間ベクトルの修正
synchronize	2 つの timeseries オブジェクトを共通の時間ベクトルを使用して同期およびリサンプリングする

クエリ

getabstime	timeseries または tscollection 時間ベクトルを cell 配列に変換する
getdatasamples	timeseries データ サンプルへのアクセス
getdatasamplesize	timeseries データ サンプルのサイズ
getinterpmethod	timeseries の内挿法
getqualitydesc	timeseries のデータ特性
getsamples	timeseries のサブセット
getsampleusingtime	timeseries または tscollection データのサブセット
gettsafteratevent	イベント時またはイベント後の timeseries の作成
gettsafterevent	イベント後の timeseries の作成
gettsatevent	イベント時の timeseries の作成
gettsbeforeatevent	イベント時またはイベント前の timeseries の作成
gettsbeforeevent	イベント前の timeseries の作成
gettsbetweenevents	イベント間の timeseries の作成

記述統計

iqr	timeseries データの四分位数間範囲
max	timeseries データの最大値
mean	timeseries データの平均値
median	timeseries データの中央値
min	timeseries データの最小値
std	timeseries データの標準偏差
sum	timeseries データの和
var	timeseries データの分散

例

timeseries の作成

5 個のスカラー データ サンプルがある timeseries オブジェクトを作成し、timeseries の名前を指定します。次に、サンプル時間およびデータ値を表示します。

ts1 = timeseries(([5 10 15 20 25])',"Name","MyTimeSeries")

  timeseries

  Common Properties:
            Name: 'MyTimeSeries'
            Time: [5x1 double]
        TimeInfo: [1x1 tsdata.timemetadata]
            Data: [5x1 double]
        DataInfo: [1x1 tsdata.datametadata]

  More properties, Methods

ts1.Time

ans = 5×1

     0
     1
     2
     3
     4

ts1.Data

ans = 5×1

     5
    10
    15
    20
    25

5 個のデータ サンプルがある timeseries を作成します。各サンプルは長さが 2 の列ベクトルです。したがって、ゼロ秒から開始する 2 つのサンプル時間があります。

ts2 = timeseries(rand(2,5))

  timeseries

  Common Properties:
            Name: 'unnamed'
            Time: [2x1 double]
        TimeInfo: [1x1 tsdata.timemetadata]
            Data: [2x5 double]
        DataInfo: [1x1 tsdata.datametadata]

  More properties, Methods

ts2.Time

ans = 2×1

     0
     1

10 秒の間隔でサンプリングされた 5 個のデータ サンプルがある timeseries を作成します。

ts3 = timeseries((1:5)',[0 10 20 30 40])

  timeseries

  Common Properties:
            Name: 'unnamed'
            Time: [5x1 double]
        TimeInfo: [1x1 tsdata.timemetadata]
            Data: [5x1 double]
        DataInfo: [1x1 tsdata.datametadata]

  More properties, Methods

ts3.Time

ans = 5×1

     0
    10
    20
    30
    40

ts3.TimeInfo

  tsdata.timemetadata
  Namespace: tsdata

  Uniform Time:
    Length       5
    Increment    10 seconds

  Time Range:
    Start        0 seconds
    End          40 seconds

  Common Properties:
          Units: 'seconds'
         Format: ''
      StartDate: ''

  More properties, Methods

バージョン履歴

R2006a より前に導入

R2025a: timeseries オブジェクトのプロパティを変数エディターに直接表示

timeseries オブジェクトを変数エディターで開くときに、[プロパティ]、[値]、[サイズ]、および [クラス] の各フィールドが直接表示されるようになりました。timeseries データ向けの専用のエディターは表示されません。引き続き timeseries オブジェクトのすべてのプロパティにアクセスして表示することができ、この更新された表示では、そのプロパティ値の一部を編集できます。

参考

timetable | tscollection | tsdata.event | timeseries2timetable

トピック

• 時系列オブジェクトとコレクション