Acts::CompositePortalLink Class Reference

Composite portal links can graft together other portal link instances, for example grids that could not be merged due to invalid binnings. More...

#include <Acts/Geometry/CompositePortalLink.hpp>

Inheritance diagram for Acts::CompositePortalLink:

Collaboration diagram for Acts::CompositePortalLink:

Public Types
using	PortalLinkRange
	Type alias for range of portal links with const dereferencing transform.

Public Member Functions
	CompositePortalLink (std::unique_ptr< PortalLinkBase > a, std::unique_ptr< PortalLinkBase > b, AxisDirection direction, bool flatten=true)
	Construct a composite portal from two arbitrary other portal links.
	CompositePortalLink (std::vector< std::unique_ptr< PortalLinkBase > > links, AxisDirection direction, bool flatten=true)
	Construct a composite portal from any number of arbitrary other portal links.
std::size_t	depth () const
	Get the depth of the composite tree.
PortalLinkRange	links () const
	Get the range of children.
std::unique_ptr< GridPortalLink >	makeGrid (const GeometryContext &gctx, const Logger &logger) const
	(Potentially) create a grid portal link that represents this composite portal link.
Result< const TrackingVolume * >	resolveVolume (const GeometryContext &gctx, const Vector2 &position, double tolerance=s_onSurfaceTolerance) const override
	Resolve the volume for a 2D position.
Result< const TrackingVolume * >	resolveVolume (const GeometryContext &gctx, const Vector3 &position, double tolerance=s_onSurfaceTolerance) const override
	Resolve the volume for a 3D position.
std::size_t	size () const
	Get the number of children.
void	toStream (std::ostream &os) const override
	Print the composite portal link.
Public Member Functions inherited from Acts::PortalLinkBase
virtual	~PortalLinkBase ()=default
	Virtual destructor in case the object is held as a derived.
void	setSurface (std::shared_ptr< RegularSurface > surface)
	Setter for the surface.
const RegularSurface &	surface () const
	Getter for the associated surface.
const std::shared_ptr< RegularSurface > &	surfacePtr () const
	Getter for the underlying shared pointer.

Additional Inherited Members
Static Public Member Functions inherited from Acts::PortalLinkBase
static std::unique_ptr< PortalLinkBase >	merge (std::unique_ptr< PortalLinkBase > a, std::unique_ptr< PortalLinkBase > b, AxisDirection direction, const Logger &logger=getDummyLogger())
	Merge two portal link into a single one.
Protected Member Functions inherited from Acts::PortalLinkBase
	PortalLinkBase (std::shared_ptr< RegularSurface > surface)
	Constructor from a surface.
Static Protected Member Functions inherited from Acts::PortalLinkBase
static void	checkMergePreconditions (const PortalLinkBase &a, const PortalLinkBase &b, AxisDirection direction)
	Helper function to check a number of preconditions before merging is executed.
Protected Attributes inherited from Acts::PortalLinkBase
std::shared_ptr< RegularSurface >	m_surface
	Surface associated with this portal link.

Detailed Description

Composite portal links can graft together other portal link instances, for example grids that could not be merged due to invalid binnings.

+-------+      +-------+
|       |      |       |
|       |      |       |
|       |      |       |
+-------+      |       |
|       |      |       |
|       |  +   +-------+
|       |      |       |
+-------+      |       |
|       |      |       |
|       |      +-------+
|       |      |       |
+-------+      +-------+

During resolution, it will consult each of it's children and return the result on the first surface where the lookup position is within bounds.

Member Typedef Documentation

PortalLinkRange

using Acts::CompositePortalLink::PortalLinkRange

Initial value:

 detail::TransformRange<
      detail::ConstDereference,
      const boost::container::small_vector<std::unique_ptr<PortalLinkBase>, 4>>

Type alias for range of portal links with const dereferencing transform.

Constructor & Destructor Documentation

CompositePortalLink() [1/2]

Acts::CompositePortalLink::CompositePortalLink	(	std::unique_ptr< PortalLinkBase >	a,
		std::unique_ptr< PortalLinkBase >	b,
		AxisDirection	direction,
		bool	flatten = true )

Construct a composite portal from two arbitrary other portal links.

The only requirement is that the portal link surfaces are mergeable.

Parameters

a	The first portal link
b	The second portal link
direction	The binning direction
flatten	If true, the composite will flatten any nested composite

CompositePortalLink() [2/2]

Acts::CompositePortalLink::CompositePortalLink	(	std::vector< std::unique_ptr< PortalLinkBase > >	links,
		AxisDirection	direction,
		bool	flatten = true )

Construct a composite portal from any number of arbitrary other portal links.

The only requirement is that the portal link surfaces are mergeable.

Parameters

links	The portal links
direction	The binning direction
flatten	If true, the composite will flatten any nested composite

Member Function Documentation

depth()

std::size_t Acts::CompositePortalLink::depth

(

)

const

Get the depth of the composite tree.

Returns

The depth

links()

PortalLinkRange Acts::CompositePortalLink::links

(

)

const

Get the range of children.

Returns

The range of children

makeGrid()

std::unique_ptr< GridPortalLink > Acts::CompositePortalLink::makeGrid	(	const GeometryContext &	gctx,
		const Logger &	logger ) const

(Potentially) create a grid portal link that represents this composite portal link.

Note

This only works, if the composite is flat and only contains trivial portal links. If these preconditions are not met, this function returns a nullptr.

Parameters

gctx	The geometry context
logger	The logger

Returns

The grid portal link

resolveVolume() [1/2]

Result< const TrackingVolume * > Acts::CompositePortalLink::resolveVolume ( const GeometryContext & gctx, const Vector2 & position, double tolerance = s_onSurfaceTolerance ) const

overridevirtual

Resolve the volume for a 2D position.

Note

This will transform the position to global coordinates before consulting its children.

position is assumed to be on surface

Parameters

gctx	The geometry context
position	The 2D position
tolerance	The on-surface tolerance

Returns

Result containing the resolved tracking volume or error

Implements Acts::PortalLinkBase.

resolveVolume() [2/2]

Result< const TrackingVolume * > Acts::CompositePortalLink::resolveVolume ( const GeometryContext & gctx, const Vector3 & position, double tolerance = s_onSurfaceTolerance ) const

overridevirtual

Resolve the volume for a 3D position.

Note

position is assumed to be on surface

Parameters

gctx	The geometry context
position	The 3D position
tolerance	The tolerance

Returns

Result containing the resolved tracking volume or error

Implements Acts::PortalLinkBase.

size()

std::size_t Acts::CompositePortalLink::size

(

)

const

Get the number of children.

Returns

The number of children

toStream()

void Acts::CompositePortalLink::toStream ( std::ostream & os ) const

overridevirtual

Print the composite portal link.

Parameters

os	The output stream

Implements Acts::PortalLinkBase.