Changes between Version 5 and Version 6 of 802.11/wlan_exp/log/util

Timestamp:

Mar 22, 2014, 5:14:56 PM (10 years ago)

Author:

murphpo

Comment:

--

802.11/wlan_exp/log/util

@@ -19 +19 @@
 }}}
 
-'''Important''': the log data index can be generated without any knowledge of the meaning of each log entry type. The index is keyed by the integer log entry type IDs contained in the log data itself. The log data index and log data always correspond 1:1 - once generated, the log data index can be saved alongside the log data and re-used as needed. Refer to the {{{log_data_to_hdf5}}} utility for an example implementation.
+'''Important''': the log data index can be generated without any knowledge of the meaning of each log entry type. The index is keyed by the integer log entry type IDs contained in the log data itself. The log data index and log data always correspond 1:1 - once generated, the log data index can be saved alongside the log data and re-used as needed.
+
+Refer to the {{{log_data_to_hdf5}}} utility for an example use of the  implementation.
+
+== Log File Writing & Reading ==
+The wlan_exp_log framework uses the HDF5 file format to store raw log data and indexes.
+
+The {{{log_data_to_hdf5}}} method will store log data in a new or existing HDF5 file. It will also generate and store the corresponding log data index.
+
+The {{{hdf5_to_log_data}}} method will retrieve log data from an HDF5 file created by {{{log_data_to_hdf5}}}. {{{hdf5_to_log_data_index}}} will retrieve the corresponding log data index.
+
+Refer to the {{{warpnet_example_wlan_log_read.py}}} script for an example of retrieving log data from a node and writing it to an HDF5 file.
+
+Refer to the {{{warpnet_example_wlan_log_parse.py}}} script for an example of reading log data and its index from an HDF5 file.
 
 == Log Index Translation & Filtering ==
@@ -47 +60 @@
 log_index = log_util.filter_log_index(log_data_index, include_only=['RX_ALL', 'TX'], merge={'RX_ALL':['RX_OFDM', 'RX_DSSS']})
 }}}
+
+Refer to the {{{warpnet_example_wlan_log_parse.py}}} script for an example of using the {{{filter_log_index}}} method.
+
+== Log to numpy Array Translation ==
+The {{{log_data_to_np_arrays}}} method translates raw log data into a dictionary of numpy record arrays. Each numpy array represents all log entries of a single type, with field names and data types defined for log entry type. The output dictionary uses the same keys as the log_index argument, which must correspond to valid WlanExpLogEntryType objects.
+
+Refer to the {{{warpnet_example_wlan_log_parse.py}}} script for an example of using the {{{log_data_to_np_arrays}}} method.