UCI Smartphone Dataset Loader

`UCIHAR`

UCI Smartphoneデータセットに記録されているセンサデータとメタデータを読み込む．

Parameters:

Name	Type	Description	Default
`path`	`Path`	UCI Smartphoneデータセットのパス． 'train'と'test'ディレクトリが置かれているディレクトリを指定する．	required

`load(self, train=True, person_list=None)`

UCI Smartphoneデータセットを読み込み，sliding-window処理を行ったデータを返す．

Parameters:

Name	Type	Description	Default
`train`	`bool`	訓練データとテストデータのどちらを読み込むか選択する． (Caution) このパラメータは今後廃止する予定．	`True`
`person_list`	`Optional[list]`	ロードする被験者を指定する．指定されない場合はすべての被験者のデータを返す．被験者は計9名おり，それぞれに整数のIDが割り当てられている．	`None`

Examples:

>>> ucihar_path = Path('path/to/dataset')
>>> ucihar = UCIHAR(ucihar_path)
>>>
>>> person_list = [1, 2, 5, 7, 9]
>>> x, y = ucihar.load(train=True, person_list=person_list)
>>> print(f'x: {x.shape}, y: {y.shape}')
>>>
>>> # > x: (?, 9, 128), y: (?, 3)

Returns:

Type Description

Tuple[numpy.ndarray, numpy.ndarray]

sliding-windowで切り出した入力とターゲットのフレームリスト

x_framesは3次元配列で構造は大まかに(Batch, Channels, Frame)のようになっている． Channelsは加速度センサ及びジャイロセンサの各軸を表しており，先頭からtotal_acc_x, total_acc_y, total_acc_z, body_acc_x, body_acc_y, body_acc_z, body_gyro_x, body_gyro_y, body_gyro_zである．

y_framesは2次元配列で構造は大まかに(Batch, Labels)のようになっている． Labelsは先頭からactivity，subject，trainフラグを表している．

activity label以外y_framesのデータはデータセット内の値をそのまま返すため，分類で用いる際はラベルの再割り当てが必要となることに注意する．

`load(path)`

Function for loading UCI Smartphone dataset

Parameters:

Name	Type	Description	Default
`path`	`Union[pathlib.Path, str]`	Directory path of UCI Smartphone dataset.	required

Returns:

Type	Description
`Tuple[List[pandas.core.frame.DataFrame], pandas.core.frame.DataFrame]`	Sensor data segmented by activity and subject.

`load_meta(path)`

Function for loading meta data of UCI Smartphone dataset

Parameters:

Name	Type	Description	Default
`path`	`Union[pathlib.Path, str]`	Directory path of UCI Smartphone dataset, which includes 'train' and 'test' directory.	required

Returns:

Type	Description
`DataFrame`	meta data of HASC dataset.

`load_raw(path)`

Function for loading raw data of UCI Smartphone dataset

Parameters:

Name	Type	Description	Default
`path`	`Path`	Directory path of UCI Smartphone dataset, which includes 'train' and 'test' directory.	required

Returns:

Type Description

Tuple[numpy.ndarray, pandas.core.frame.DataFrame]

raw data of UCI Smartphone dataset

Shape of sensor_data is (?, 9, 128).