ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

timeseries

timeseries オブジェクトの作成

説明

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

作成

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

説明

ts = timeseries(datavals) は、datavals のデータを含む timeseries オブジェクトを返します。

ts = timeseries(datavals,timevals) は、datavals のデータを含み、ベクトル timevals の時刻に対応する timeseries オブジェクトを返します。

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

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

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

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

入力引数

すべて展開する

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

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

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

形式
dd-mmm-yyyy HH:MM:SS01-Mar-2000 15:45:17
dd-mmm-yyyy01-Mar-2000
mm/dd/yy03/01/00
mm/dd03/01
HH:MM:SS15:45:17
HH:MM:SS PM3:45:17 PM
HH:MM15:45
HH:MM PM3:45 PM
mmm.dd,yyyy HH:MM:SSMar.01,2000 15:45:17
mmm.dd,yyyyMar.01,2000
mm/dd/yyyy03/01/2000

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

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

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

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

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

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

プロパティ

すべて展開する

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

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

Dependenttrue

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

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

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

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

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

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

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

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

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

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

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

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

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

  • Units — 時間の単位。

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

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

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

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

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

Dependenttrue
SetAccess'protected'

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

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

Dependenttrue
SetAccess'protected'

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

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

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

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

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

Dependenttrue

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

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

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

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

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

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

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

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

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

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

Dependenttrue

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

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

  • Start — 開始時間。

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

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

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

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

  • StartDate — 基準日を定義する日付文字ベクトル (setabstime を参照)。

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

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

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

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

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

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

オブジェクト関数

すべて展開する

addeventtimeseries へのイベントの追加
addsampleデータ サンプルを timeseries オブジェクトに追加
appendtimeseries オブジェクトを時間順に連結
deleventtimeseries からイベントを削除
delsampletimeseries オブジェクトからサンプルを削除
detrendtimeseries オブジェクトからの平均値または最適な近似の減算
filtertimeseries オブジェクトの周波数成分の変更
idealfiltertimeseries の理想フィルター
plottimeseries のプロット
resampletimeseries 時間ベクトルのリサンプリング
settimeseries プロパティの設定
setabstimetimeseries 時間を日付文字ベクトルとして設定
setinterpmethodtimeseries オブジェクトに既定の内挿法を設定
setuniformtimetimeseries の等間隔時間ベクトルの修正
synchronize2 つの timeseries オブジェクトを共通の時間ベクトルを使用して同期およびリサンプリングする
gettimeseries プロパティのクエリ
getabstimetimeseries 時間ベクトルを cell 配列に変換
getdatasamplestimeseries データ サンプルへのアクセス
getdatasamplesizetimeseries データ サンプルのサイズ
getinterpmethodtimeseries の内挿法
getqualitydesctimeseries のデータ特性
getsamplestimeseries のサブセット
getsampleusingtimetimeseries データのサブセット
gettsafterateventイベント時またはイベント後に timeseries を作成
gettsaftereventイベント後に timeseries を作成
gettsateventイベント時の timeseries を作成
gettsbeforeateventイベント時またはイベント前の timeseries の作成
gettsbeforeeventイベント前の timeseries を作成
gettsbetweeneventsイベント間の timeseries を作成
iqrtimeseries データの四分位数間範囲
maxtimeseries データの最大値
meantimeseries データの平均値
mediantimeseries データの中央値
mintimeseries データの最小値
stdtimeseries データの標準偏差
sumtimeseries データの和
vartimeseries データの分散

すべて折りたたむ

5 個のスカラー データ サンプルがある timeseries オブジェクトを作成し、timeseries の名前を指定します。

ts1 = timeseries((1:5)','Name','MyTimeSeries');

5 個のデータ サンプルがある timeseries を作成します。各サンプルは長さが 2 の列ベクトルです。

ts2 = timeseries(rand(2,5));

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

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

R2006a より前に導入