ericyxy98 commited on
Commit
e9d4e05
1 Parent(s): 0a99abc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +70 -47
README.md CHANGED
@@ -19,67 +19,90 @@ AWARE/PTEase is a smartphone-based sensing system designed to examine human airw
19
 
20
  This dataset includes the raw and pre-processed acoustic data, arranged in 3 parts:
21
 
22
- - "aware_raw": Raw .wav files
23
 
24
- - Subfolders are named by the subjects' ID (from 1 to 382)
25
-
26
- - In each subfolder, there are three "cali_X.wav" files and multiple "test_X.wav" files
27
-
28
- - "cali_1.wav" : Calibration step 1 - long tube calibration - consists of 12 pairs of received pulses. Each pair contains one wide-band (0-16Hz) pulse and one narrow-band (0-200Hz) pulse. The narrow-band pulses are deperacated and only the wide-band pulses are used. Transmitting period for each pair is 0.4 sec.
29
-
30
- - "cali_2.wav" : Calibration step 2 - standard tube close-end calibration - is the same as above except the calibrations are conducted in a different setting.
31
-
32
- - "cali_3.wav" : Calibration step 3 - standard tube open-end calibration - is the same as above except the calibrations are conducted in a different setting.
33
 
34
- - "test_X.wav" : Test number X - the subject's X-th attempt of conducting the test - follows the protocol of "Nasal breathing -> Inhale -> Exhale -> Inhale -> Exhale -> Inhale -> Exhale". Each segment contains 25 pulses collected at an interval of 0.2 sec. NOTE: Some of the samples have 50 pulses for the "Nasal breathing" phase.
 
 
 
 
 
 
35
 
36
 
37
- - "aware_segmented": Segmented and aligned acoustic pulses
38
-
39
- - "aware_segmented.csv" and "headers.txt"
40
-
41
- - Column 1-46 : Basic subject information, including demographics, clinical measurements and labels. See "headers.txt".
42
- - Column 1 : Subject ID
43
- - Column 2-10 : Demographics
44
- - Column 11 : Disease label
45
- - Column 12-22 : Impulse Oscillometry Measurements
46
- - Column 23-31 : Spirometry measurements
47
- - Column 32-45 : Spirometry measurements in post-bronchodilator test
48
- - Column 46 : Test number
49
-
50
- - Column 47-1012846 : Acoustic signals (16-bit PCM, sample rate = 48000). Arranged by different phases. Each calibration phase contains 12 measurements and each testing phase contains 25 measurements. Each measurement last for 0.1 sec (4800 sample points).
51
- - Column 47-57646 : Phase "Calibration #1". Flattend from [12,4800] by row-major order.
52
- - Column 57647-115246 : Phase "Calibration #2". Flattend from [12,4800] by row-major order.
53
- - Column 115247-172846 : Phase "Calibration #3". Flattend from [12,4800] by row-major order.
54
- - Column 172847-292846 : Phase "Nasal breathing". Flattend from [25,4800] by row-major order.
55
- - Column 292847-412846 : Phase "Inhale #1". Flattend from [25,4800] by row-major order.
56
- - Column 412847-532846 : Phase "Inhale #2". Flattend from [25,4800] by row-major order.
57
- - Column 532847-652846 : Phase "Inhale #3". Flattend from [25,4800] by row-major order.
58
- - Column 652847-772846 : Phase "Exhale #1". Flattend from [25,4800] by row-major order.
59
- - Column 772847-892846 : Phase "Exhale #2". Flattend from [25,4800] by row-major order.
60
- - Column 892847-1012846 : Phase "Exhale #3". Flattend from [25,4800] by row-major order.
61
 
62
  - "aware_segmented.pkl"
63
 
64
- - Python pandas.DataFrame saved as pickle file. Same contents as "aware_segmented.csv", but without flattening.
65
 
66
- - To load the data, use the following commends:
67
 
68
  ``` python
69
  import pandas as pd
70
  df = pd.read_pickle("aware_segmented.pkl")
71
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
72
 
73
-
74
- - "aware_csa": Processed airway cross-sectional area (CSA) curves infered from the acoustic signals
75
-
76
- - NOTE: Not all raw samples are used for airway CSA reconsturctions. Low-quality data is discarded, thus the sample size of this part is smaller than above
77
-
78
- - "aware_csa.csv" and "headers.txt"
79
-
80
- Column 1-46 : Basic subject information. Same as "aware_segmented.csv". See "headers.txt".
81
-
82
- Column 47-130: Reconstructed airway cross-sectional area at different depth from mouth.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
83
 
84
 
85
  For more information about this dataset please contact: eric.yin@pitt.edu
 
19
 
20
  This dataset includes the raw and pre-processed acoustic data, arranged in 3 parts:
21
 
22
+ - Raw WAV files
23
 
24
+ - "aware_raw.zip"
25
+
26
+ - Subfolders are named by the subjects' ID (from 1 to 382). In each subfolder, there are three "cali_X.wav" files and multiple "test_X.wav" files
 
 
 
 
 
 
27
 
28
+ - "cali_1.wav" : Calibration step 1 - long tube calibration - consists of 12 pairs of received pulses. Each pair contains one wide-band (0-16Hz) pulse and one narrow-band (0-200Hz) pulse. The narrow-band pulses are deperacated and only the wide-band pulses are used. Transmitting period for each pair is 0.4 sec.
29
+
30
+ - "cali_2.wav" : Calibration step 2 - standard tube close-end calibration - is the same as above except the calibrations are conducted in a different setting.
31
+
32
+ - "cali_3.wav" : Calibration step 3 - standard tube open-end calibration - is the same as above except the calibrations are conducted in a different setting.
33
+
34
+ - "test_X.wav" : Test number X - the subject's X-th attempt of conducting the test - follows the protocol of "Nasal breathing -> Inhale -> Exhale -> Inhale -> Exhale -> Inhale -> Exhale". Each segment contains 25 pulses collected at an interval of 0.2 sec. NOTE: Some of the samples have 50 pulses for the "Nasal breathing" phase.
35
 
36
 
37
+ - Segmented and aligned acoustic pulses
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
38
 
39
  - "aware_segmented.pkl"
40
 
41
+ - Python pandas.DataFrame saved as a PICKLE file. Same contents as "aware_segmented.csv", but without flattening.
42
 
43
+ - To load the data, use the following commands:
44
 
45
  ``` python
46
  import pandas as pd
47
  df = pd.read_pickle("aware_segmented.pkl")
48
  ```
49
+ - Column 0-45 : Basic subject information, including demographics, clinical measurements and labels.
50
+ - Column 0 : Subject ID
51
+ - Column 1-9 : Demographics
52
+ - Column 10 : Disease label
53
+ - Column 11-21 : Impulse Oscillometry Measurements
54
+ - Column 22-30 : Spirometry measurements
55
+ - Column 31-44 : Spirometry measurements in post-bronchodilator test
56
+ - Column 45 : Test number
57
+
58
+ - Column 46-55 : Acoustic signals (16-bit PCM, sample rate = 48000) arranged by different phases. Each calibration phase contains 12 measurements and each testing phase contains 25 measurements. Each measurement lasts for 0.1 sec (4800 sample points).
59
+ - Column 46 : Phase "Calibration #1". Each element is a [12,4800] NumPy ndarray
60
+ - Column 47 : Phase "Calibration #2". Each element is a [12,4800] NumPy ndarray
61
+ - Column 48 : Phase "Calibration #3". Each element is a [12,4800] NumPy ndarray
62
+ - Column 49 : Phase "Nasal breathing". Each element is a [25,4800] NumPy ndarray
63
+ - Column 50 : Phase "Inhale #1". Each element is a [25,4800] NumPy ndarray
64
+ - Column 51 : Phase "Inhale #2". Each element is a [25,4800] NumPy ndarray
65
+ - Column 52 : Phase "Inhale #3". Each element is a [25,4800] NumPy ndarray
66
+ - Column 53 : Phase "Exhale #1". Each element is a [25,4800] NumPy ndarray
67
+ - Column 54 : Phase "Exhale #2". Each element is a [25,4800] NumPy ndarray
68
+ - Column 55 : Phase "Exhale #3". Each element is a [25,4800] NumPy ndarray
69
 
70
+ - "aware_segmented.csv" and "headers.txt"
71
+
72
+ - NOTE: Directly loading this CSV file is not recommended. It could be time-consuming and buggy. Try "aware_segmented.pkl" first.
73
+
74
+ - NOTE: "aware_segmented.csv" has no headers. See column definition below.
75
+
76
+ - Column 0-45 : Basic subject information, including demographics, clinical measurements and labels.
77
+ - Column 0 : Subject ID
78
+ - Column 1-9 : Demographics
79
+ - Column 10 : Disease label
80
+ - Column 11-21 : Impulse Oscillometry Measurements
81
+ - Column 22-30 : Spirometry measurements
82
+ - Column 31-44 : Spirometry measurements in post-bronchodilator test
83
+ - Column 45 : Test number
84
+
85
+ - Column 46-1012845 : Acoustic signals (16-bit PCM, sample rate = 48000) arranged by different phases. Each calibration phase contains 12 measurements and each testing phase contains 25 measurements. Each measurement lasts for 0.1 sec (4800 sample points).
86
+ - Column 46-57645 : Phase "Calibration #1". Flattened from [12,4800] by row-major order.
87
+ - Column 57646-115245 : Phase "Calibration #2". Flattened from [12,4800] by row-major order.
88
+ - Column 115246-172845 : Phase "Calibration #3". Flattened from [12,4800] by row-major order.
89
+ - Column 172846-292845 : Phase "Nasal breathing". Flattened from [25,4800] by row-major order.
90
+ - Column 292846-412845 : Phase "Inhale #1". Flattened from [25,4800] by row-major order.
91
+ - Column 412846-532845 : Phase "Inhale #2". Flattened from [25,4800] by row-major order.
92
+ - Column 532846-652845 : Phase "Inhale #3". Flattened from [25,4800] by row-major order.
93
+ - Column 652846-772845 : Phase "Exhale #1". Flattened from [25,4800] by row-major order.
94
+ - Column 772846-892845 : Phase "Exhale #2". Flattened from [25,4800] by row-major order.
95
+ - Column 892846-1012845 : Phase "Exhale #3". Flattened from [25,4800] by row-major order.
96
+
97
+ - Processed airway cross-sectional area (CSA) curves inferred from the acoustic signals
98
+
99
+ - "aware_csa.csv"
100
+
101
+ - NOTE: Not all raw samples are used for airway CSA reconstructions. Low-quality data is discarded, thus the sample size of this part is smaller than above
102
+
103
+ - Column 1-46 : Basic subject information. Same as "aware_segmented.csv".
104
+
105
+ - Column 47-130: Reconstructed airway cross-sectional area at different depths from mouth.
106
 
107
 
108
  For more information about this dataset please contact: eric.yin@pitt.edu