Skip to content

Commit ff6f57a

Browse files
committed
Made the plotting tool documentation more explicit.
1 parent 993c352 commit ff6f57a

File tree

2 files changed

+27
-15
lines changed

2 files changed

+27
-15
lines changed

performance/src/resolution/stat_plot_tool.hpp

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,25 +59,34 @@ class stat_plot_tool {
5959

6060
/// @brief fill the cache
6161
///
62+
/// @tparam track_candidate_backend_t the backend type for @c find_res
63+
///
6264
/// @param cache the cache for statistics plots
6365
/// @param find_res track finding result
64-
template <typename T>
65-
void fill(stat_plot_cache& cache,
66-
const edm::track_candidate<T>& find_res) const;
66+
template <typename track_candidate_backend_t>
67+
void fill(
68+
stat_plot_cache& cache,
69+
const edm::track_candidate<track_candidate_backend_t>& find_res) const;
6770

6871
/// @brief fill the cache
6972
///
73+
/// @tparam track_fit_backend_t the backend type for @c fit_res
74+
///
7075
/// @param cache the cache for statistics plots
7176
/// @param fit_res fitting information that contains statistics
72-
template <typename T>
73-
void fill(stat_plot_cache& cache, const edm::track_fit<T>& fit_res) const;
77+
template <typename track_fit_backend_t>
78+
void fill(stat_plot_cache& cache,
79+
const edm::track_fit<track_fit_backend_t>& fit_res) const;
7480

7581
/// @brief fill the cache
7682
///
83+
/// @tparam track_state_backend_t the backend type for @c trk_state
84+
///
7785
/// @param cache the cache for statistics plots
7886
/// @param trk_state track state at local measurements
79-
template <typename T>
80-
void fill(stat_plot_cache& cache, const edm::track_state<T>& trk_state,
87+
template <typename track_state_backend_t>
88+
void fill(stat_plot_cache& cache,
89+
const edm::track_state<track_state_backend_t>& trk_state,
8190
const measurement_collection_types::host& measurements) const;
8291

8392
/// @brief fill the cache

performance/src/resolution/stat_plot_tool.ipp

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@
1212

1313
namespace traccc {
1414

15-
template <typename T>
16-
void stat_plot_tool::fill(stat_plot_cache& cache,
17-
const edm::track_candidate<T>& find_res) const {
15+
template <typename track_candidate_backend_t>
16+
void stat_plot_tool::fill(
17+
stat_plot_cache& cache,
18+
const edm::track_candidate<track_candidate_backend_t>& find_res) const {
1819

1920
// Avoid unused variable warnings when building the code without ROOT.
2021
(void)cache;
@@ -30,9 +31,10 @@ void stat_plot_tool::fill(stat_plot_cache& cache,
3031
#endif // TRACCC_HAVE_ROOT
3132
}
3233

33-
template <typename T>
34-
void stat_plot_tool::fill(stat_plot_cache& cache,
35-
const edm::track_fit<T>& fit_res) const {
34+
template <typename track_fit_backend_t>
35+
void stat_plot_tool::fill(
36+
stat_plot_cache& cache,
37+
const edm::track_fit<track_fit_backend_t>& fit_res) const {
3638

3739
// Avoid unused variable warnings when building the code without ROOT.
3840
(void)cache;
@@ -48,9 +50,10 @@ void stat_plot_tool::fill(stat_plot_cache& cache,
4850
#endif // TRACCC_HAVE_ROOT
4951
}
5052

51-
template <typename T>
53+
template <typename track_state_backend_t>
5254
void stat_plot_tool::fill(
53-
stat_plot_cache& cache, const edm::track_state<T>& trk_state,
55+
stat_plot_cache& cache,
56+
const edm::track_state<track_state_backend_t>& trk_state,
5457
const measurement_collection_types::host& measurements) const {
5558

5659
// Avoid unused variable warnings when building the code without ROOT.

0 commit comments

Comments
 (0)