feat(nav): Gen3 Navigation policies and factory #3760
Conversation
Their lifetime needs to be controlled
github-actions
bot
added
Component - Core
|
@asalzburger I'm making some changes to the |
|
After discussion with @andiwand, I refactored the interface of the function contained in the I'm also wrapping the navigation stream into a separate wrapper object called This is to be complemented (in a future PR) with a method like |
|
CI is green now @andiwand |
|
acts-project-service
added
the
Fails Athena tests
Terminology:
- "Navigation delegate": the function that is registered with a tracking volume. In principle, this can be anything
- "Navigation policy": the object that is registered with the tracking volume. It contains a method that is connected to the "navigation delegate". It has extra methods
- "Navigation policy factory": To delay construction of the actual policy object **until after** the volume is fully sized and has all of its internal structure registered, the blueprint tree only contains *navigation policy factories*. This is configurable. During construction, the factory is applied to volumes, and produces a policy that is registered with the volume. This is called "navigation policy factory" from a conceptual point of view.
- "MultiNavigationPolicy": chains together multiple policies in a sort of composition. You can have one policy that only deals with portals, one for sensitive and one for passive surfaces, for example.
- To make this less annoying to construct, as you would have to manage the factory, I'm adding a concrete class `NavigationPolicyFactory`. Its job is to make defining a factory that produces a "MultiNavigationPolicy" easy, like:
```cpp
using namespace Acts;
using SurfaceArrayNavigationPolicy::LayerType;
SurfaceArrayNavigationPolicy::Config config{
.layerType = LayerType::Cylinder,
.bins = {10, 10}
};
auto factory = NavigationPolicyFactory::make()
.add<TryAllPortalNavigationPolicy>()
.add<SurfaceArrayNavigationPolicy>(config);
```
or in python:
```python
policy = (
acts.NavigationPolicyFactory.make()
.add(acts.TryAllPortalNavigationPolicy)
.add(acts.TryAllSurfaceNavigationPolicy)
.add(
acts.SurfaceArrayNavigationPolicy,
acts.SurfaceArrayNavigationPolicy.Config(
layerType=acts.SurfaceArrayNavigationPolicy.LayerType.Plane,
bins=(10, 10),
),
)
)
```
Part of acts-project#3502
Terminology:
NavigationPolicyFactory. Its job is to make defining a factory that produces a "MultiNavigationPolicy" easy, like:Part of #3502