Improve documentation of the SiSpSeededTrackFinder and SiSpacePointsSeedMaker_ATLxk

This MR, as part of https://its.cern.ch/jira/browse/ATLIDTRKCP-263, attempts to improve a bit the readability of the track finder top level algorithm, as well as the seed finder tool.

In particular, comments were added explaining what is being done, and variable names were changed to be hopefully a bit more expressive.

In addition, a few C-style arrays were replaced by std containers in non-performance-critical locations.

This MR should not affect the reconstruction outcome or speed. This was tested on 100 mu=60 ttbars, with no change in the number of seeds/candidates/tracks and a track finder algorithm CPU stable within the resolution my local desktop allows (~1-2%)

Adding @sroe, @goetz for IDSW, and @npetters for IDTR

added Tracking master labels

Dear @sroe, this MR should implement the suggestions you made in !33688 (closed)

added 40 commits

• d1371132...73fed17a - 39 commits from branch atlas:master
• ef469d30 - Merge remote-tracking branch 'upstream/master' into tuneTrackFinderDoc

Compare with previous version

added 34 commits

• ef469d30...5a2294ba - 33 commits from branch atlas:master
• 8412b749 - Merge remote-tracking branch 'upstream/master' into tuneTrackFinderDoc

Compare with previous version

unmarked as a Work In Progress

changed the description

This merge request affects 1 package:

• InnerDetector/InDetRecAlgs/SiSPSeededTrackFinder

Adding @goetz ,@gavrilen ,@sroe as watchers

added InnerDetector review-pending-level-1 labels

CI Result SUCCESS (hash 8412b749)

	Athena	AthSimulation	AnalysisBase	AthGeneration
externals
cmake
make
required tests
optional tests

Full details available on this CI monitor view
Athena: number of compilation errors 0, warnings 0
AthSimulation: number of compilation errors 0, warnings 0
AnalysisBase: number of compilation errors 0, warnings 0
AthGeneration: number of compilation errors 0, warnings 0
For experts only: Jenkins output [CI-MERGE-REQUEST-CC7 15429]

Hi @goblirsc,

thanks! Indeed more readable than before.

As for the c-style arrays: std::array is just as fast.

• Walter

added 3 commits

• cec682ea - attempt to make SiSpacePointsSeedMaker a bit more transparent for non-experts...
• d642e45b - add more non-expert documentations to the SiSpacePointsSeedMaker and rename few variables
• c64af495 - one more rename

Compare with previous version

This merge request affects 3 packages:

• InnerDetector/InDetRecAlgs/SiSPSeededTrackFinder
• InnerDetector/InDetRecEvent/SiSPSeededTrackFinderData
• InnerDetector/InDetRecTools/SiSpacePointsSeedTool_xk

Adding @goetz ,@amorley ,@gavrilen ,@sroe as watchers

Taking this opportunity to add a set of similar changes for the seed maker tool, to allow for review in one go on Monday.

changed the description

changed title from Improve documentation of the SiSpSeededTrackFinder to Improve documentation of the SiSpSeededTrackFinder and SiSpacePointsSeedMaker_ATLxk

CI Result SUCCESS (hash c64af495)

	Athena	AthSimulation	AnalysisBase	AthGeneration
externals
cmake
make
required tests
optional tests

Full details available on this CI monitor view
Athena: number of compilation errors 0, warnings 0
AthSimulation: number of compilation errors 0, warnings 0
AnalysisBase: number of compilation errors 0, warnings 0
AthGeneration: number of compilation errors 0, warnings 0
For experts only: Jenkins output [CI-MERGE-REQUEST-CC7 15483]

added 1 commit

• 78adb5f2 - std math functions and constexpr

Compare with previous version

resolved all threads

This merge request affects 3 packages:

• InnerDetector/InDetRecAlgs/SiSPSeededTrackFinder
• InnerDetector/InDetRecEvent/SiSPSeededTrackFinderData
• InnerDetector/InDetRecTools/SiSpacePointsSeedTool_xk

Adding @goetz ,@amorley ,@gavrilen ,@sroe as watchers

CI Result SUCCESS (hash 78adb5f2)

	Athena	AthSimulation	AnalysisBase	AthGeneration
externals
cmake
make
required tests
optional tests

Full details available on this CI monitor view
Athena: number of compilation errors 0, warnings 0
AthSimulation: number of compilation errors 0, warnings 0
AnalysisBase: number of compilation errors 0, warnings 0
AthGeneration: number of compilation errors 0, warnings 0
For experts only: Jenkins output [CI-MERGE-REQUEST-CC7 15496]

Thank you very much for making these changes. The code is much easier to read. A lot of your comments are in Doxygen style, but many are not. Could you please update all of your comments to be Doxygen style?

added review-user-action-required label and removed review-pending-level-1 label

Hi @jveatch, many thanks for reviewing this MR! Regarding the Doxygen style, happy to update - is this referring to the headers or also the implementation files? Cheers, Max

added 2 commits

• 75006c87 - remove commended lines
• a5c22ecb - updates to doxygen style in cxx files, add some small tweaks...

Compare with previous version

This merge request affects 3 packages:

• InnerDetector/InDetRecAlgs/SiSPSeededTrackFinder
• InnerDetector/InDetRecEvent/SiSPSeededTrackFinderData
• InnerDetector/InDetRecTools/SiSpacePointsSeedTool_xk

Adding @goetz ,@amorley ,@gavrilen ,@sroe as watchers

added review-pending-level-1 label and removed review-user-action-required label

added 192 commits

• a5c22ecb...77ee0a8e - 191 commits from branch atlas:master
• f9676918 - Merge remote-tracking branch 'upstream/master' into tuneTrackFinderDoc

Compare with previous version

This merge request affects 3 packages:

• InnerDetector/InDetRecAlgs/SiSPSeededTrackFinder
• InnerDetector/InDetRecEvent/SiSPSeededTrackFinderData
• InnerDetector/InDetRecTools/SiSpacePointsSeedTool_xk

Adding @goetz ,@amorley ,@gavrilen ,@sroe as watchers

resolved all threads

resolved all threads

resolved all threads

CI Result SUCCESS (hash a5c22ecb)

	Athena	AthSimulation	AnalysisBase	AthGeneration
externals
cmake
make
required tests
optional tests

Full details available on this CI monitor view
Athena: number of compilation errors 0, warnings 0
AthSimulation: number of compilation errors 0, warnings 0
AnalysisBase: number of compilation errors 0, warnings 0
AthGeneration: number of compilation errors 0, warnings 0
For experts only: Jenkins output [CI-MERGE-REQUEST-CC7 15550]

CI Result SUCCESS (hash f9676918)

	Athena	AthSimulation	AnalysisBase	AthGeneration
externals
cmake
make
required tests
optional tests

Full details available on this CI monitor view
Athena: number of compilation errors 0, warnings 0
AthSimulation: number of compilation errors 0, warnings 0
AnalysisBase: number of compilation errors 0, warnings 0
AthGeneration: number of compilation errors 0, warnings 0
For experts only: Jenkins output [CI-MERGE-REQUEST-CC7 15551]

The comments look a lot better. Overall, the changes look fine to me and there are no CI issues. Approving.

Jason (L1)

added review-approved label and removed review-pending-level-1 label

merged

mentioned in commit e44645a8

added sweep:ignore label