niklas/ros2_tracing
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add section describing analysis design

Browse source
This commit is contained in:
Christophe Bedard 2019-12-31 18:04:36 -05:00
parent 758bb18618
commit 5f9786c9f5
1 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/design_ros_2.md
View file

@ -647,9 +647,19 @@ tracetools_analysis <-- ros2trace_analysis
@enduml
```
## Analysis architecture
## Analysis
With profiling as an example implementation.
### Design
Generally, for a given trace data analysis objective, the following classes are extended: `EventHandler`, `DataModel`, and `DataModelUtil`.
A user/developer can implement an `EventHandler`, which defines callbacks for specific events. Those callbacks get called by the `Processor`, and end up putting slightly-processed data into a `DataModel`, which is a data container that uses `pandas` `DataFrame`s.
Meaningful data can be extracted from the `DataModel`. However, a `DataModelUtil` can provide common utility functions so that users don't have to re-write them. This meaningful output data can then be presented through a Jupyter notebook (e.g. plots) or a normal Python script (e.g. tables).
### Architecture
With profiling as an example implementation:
```plantuml
@startuml