The Container stores the output produced by the SegmentNetworkProducerModule. More...

#include <DirectedNodeNetworkContainer.h>

Inheritance diagram for DirectedNodeNetworkContainer:

Collaboration diagram for DirectedNodeNetworkContainer:

[legend]

Public Types
using	StaticSectorType = VXDTFFilters< SpacePoint >::staticSector_t
	To improve readability of the code, here the definition of the static sector type.

Public Member Functions
	DirectedNodeNetworkContainer ()
	Standard constructor.

	~DirectedNodeNetworkContainer ()
	Destructor.

DirectedNodeNetwork< Belle2::ActiveSector< StaticSectorType, Belle2::TrackNode >, Belle2::VoidMetaInfo > &	accessActiveSectorNetwork ()
	*********************** PUBLIC MEMBER FUNCTIONS *********************** More...

std::deque< Belle2::ActiveSector< StaticSectorType, Belle2::TrackNode > > &	accessActiveSectors ()
	Returns reference to the actual ActiveSectors stored in this container, intended for read and write access.

std::deque< Belle2::TrackNode > &	accessTrackNodes ()
	Returns reference to the actual trackNodes stored in this container, intended for read and write access.

DirectedNodeNetwork< Belle2::TrackNode, Belle2::VoidMetaInfo > &	accessHitNetwork ()
	Returns reference to the HitNetwork stored in this container, intended for read and write access.

DirectedNodeNetwork< Belle2::Segment< Belle2::TrackNode >, Belle2::CACell > &	accessSegmentNetwork ()
	Returns reference to the SegmentNetwork stored in this container, intended for read and write access.

std::deque< Belle2::Segment< Belle2::TrackNode > > &	accessSegments ()
	Returns reference to the actual segments stored in this container, intended for read and write access.

int	sizeActiveSectors ()
	Returns number of activeSectors found.

int	sizeTrackNodes ()
	Returns number of trackNodes found.

int	sizeSegments ()
	Returns number of segments found.

int	get_trackNodesCollected ()
	Returns number of trackNodes collected.

int	get_activeSectorConnections ()
	Returns number of activeSectors connections made.

int	get_trackNodeConnections ()
	Returns number of trackNodes connections made.

int	get_segmentConnections ()
	Returns number of segments connections made.

int	get_activeSectorAddedConnections ()
	Returns number of added activeSectors connections made.

int	get_trackNodeAddedConnections ()
	Returns number of added trackNodes connections made.

int	get_segmentAddedConnections ()
	Returns number of added segments connections made.

int	get_collectedPaths ()
	Returns number of paths found.

void	set_trackNodesCollected (int in)
	Sets number of trackNodes collected.

void	set_activeSectorConnections (int in)
	Sets number of activeSectors connections made.

void	set_trackNodeConnections (int in)
	Sets number of trackNodes connections made.

void	set_segmentConnections (int in)
	Sets number of segments connections made.

void	set_activeSectorAddedConnections (int in)
	Sets number of added activeSectors connections made.

void	set_trackNodeAddedConnections (int in)
	Sets number of added trackNodes connections made.

void	set_segmentAddedConnections (int in)
	Sets number of added segments connections made.

void	set_collectedPaths (int in)
	Sets number of paths found.

void	clear ()
	Clear directed node network container Called to clear the directed node network container if the segment network size grows to large. More...

void	setVirtualInteractionPoint (B2Vector3D &pos, B2Vector3D &posError)
	Passes parameters for creating a virtual interaction point.

Belle2::TrackNode *	getVirtualInteractionPoint ()
	Returns reference to the Virtual interactionPoint stored here.

void	addRelationTo (const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (with caching). More...

void	addRelationTo (const TObject *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (no caching, can be quite slow). More...

void	copyRelations (const RelationsInterface< BASE > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights). More...

template<class TO >
RelationVector< TO >	getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from this object to another store array. More...

template<class FROM >
RelationVector< FROM >	getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from another store array to this object. More...

template<class T >
RelationVector< T >	getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
	Get the relations between this object and another store array. More...

template<class TO >
TO *	getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
	Get the object to which this object has a relation. More...

template<class FROM >
FROM *	getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the object from which this object has a relation. More...

template<class T >
T *	getRelated (const std::string &name="", const std::string &namedRelation="") const
	Get the object to or from which this object has a relation. More...

template<class TO >
std::pair< TO *, float >	getRelatedToWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing to an array. More...

template<class FROM >
std::pair< FROM *, float >	getRelatedFromWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from an array. More...

template<class T >
std::pair< T *, float >	getRelatedWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from/to an array. More...

virtual std::string	getName () const
	Return a short name that describes this object, e.g. More...

virtual std::string	getInfoHTML () const
	Return a short summary of this object's contents in HTML format. More...

std::string	getInfo () const
	Return a short summary of this object's contents in raw text format. More...

std::string	getArrayName () const
	Get name of array this object is stored in, or "" if not found.

int	getArrayIndex () const
	Returns this object's array index (in StoreArray), or -1 if not found.

Protected Member Functions
TClonesArray *	getArrayPointer () const
	Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Protected Attributes
int	m_trackNodesCollected = 0
	Number of trackNodes collected.

int	m_activeSectorConnections = 0
	Number of activeSectors connections made.

int	m_trackNodeConnections = 0
	Number of trackNodes connections made.

int	m_segmentConnections = 0
	Number of segments connections made.

int	m_activeSectorAddedConnections = 0
	Number of added activeSectors connections made.

int	m_trackNodeAddedConnections = 0
	Number of added trackNodes connections made.

int	m_segmentAddedConnections = 0
	Number of added segments connections made.

int	m_collectedPaths = 0
	Number of paths found.

DirectedNodeNetwork< ActiveSector< StaticSectorType, TrackNode >, Belle2::VoidMetaInfo >	m_ActiveSectorNetwork
	*********************** DATA MEMBERS *********************** More...

std::deque< ActiveSector< StaticSectorType, TrackNode > >	m_activeSectors
	Stores the actual ActiveSectors, since the ActiveSectorNetwork does only keep references.

DirectedNodeNetwork< TrackNode, Belle2::VoidMetaInfo >	m_HitNetwork
	Stores the full network of TrackNode< SpaacePoint>, which were accepted by activated two-hit-filters of the assigned sectorMap.

std::deque< TrackNode >	m_trackNodes
	Stores the actual trackNodes, since the SegmentNetwork does only keep references.

DirectedNodeNetwork< Segment< TrackNode >, Belle2::CACell >	m_SegmentNetwork
	Stores the full network of Segments, which were accepted by activated three-hit-filters of the assigned sectorMap.

std::deque< Segment< TrackNode > >	m_segments
	Stores the actual Segments, since the SegmentNetwork does only keep references.

Belle2::TrackNode *	m_VirtualInteractionPoint
	Stores a SpacePoint representing the virtual interaction point if set, nullptr if not.

SpacePoint *	m_VIPSpacePoint
	Stores the SpacePoint needed for the virtual IP.

Private Member Functions
	ClassDef (DirectedNodeNetworkContainer, 0)
	This class does not need a streamer as it is not supposed to be stored. More...

Private Attributes
DataStore::StoreEntry *	m_cacheDataStoreEntry
	Cache of the data store entry to which this object belongs.

int	m_cacheArrayIndex
	Cache of the index in the TClonesArray to which this object belongs.

Detailed Description

The Container stores the output produced by the SegmentNetworkProducerModule.

Is coupled to an assigned static sectorMap, which influences the structure of the DirectedNodeNetworks stored in this container. Is intended to be filled event-wise and not to be stored in root-files.

WARNING: all data members which are followed by "//!" will not be streamed by root (so no I/O for them)

TODO: create constructor for vIPs in SpacePoint. What about activeSectors for vIP? -> solution dependent of treatment in static sectorMap.

Definition at line 40 of file DirectedNodeNetworkContainer.h.

Member Function Documentation

◆ accessActiveSectorNetwork()

DirectedNodeNetwork<Belle2::ActiveSector<StaticSectorType, Belle2::TrackNode>, Belle2::VoidMetaInfo>& accessActiveSectorNetwork ( )

inline

************************* PUBLIC MEMBER FUNCTIONS *************************

Getters Returns reference to the ActiveSectorNetwork stored in this container, intended for read and write access

Definition at line 67 of file DirectedNodeNetworkContainer.h.

67 { return m_ActiveSectorNetwork; }

Belle2::DirectedNodeNetworkContainer::m_ActiveSectorNetwork

DirectedNodeNetwork< ActiveSector< StaticSectorType, TrackNode >, Belle2::VoidMetaInfo > m_ActiveSectorNetwork

************************* DATA MEMBERS *************************

Definition: DirectedNodeNetworkContainer.h:177

◆ addRelationTo() [1/2]

void addRelationTo	(	const RelationsInterface< BASE > *	object,
		float	weight = `1.0`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Add a relation from this object to another object (with caching).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

◆ addRelationTo() [2/2]

void addRelationTo	(	const TObject *	object,
		float	weight = `1.0`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Add a relation from this object to another object (no caching, can be quite slow).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

◆ ClassDef()

ClassDef	(	DirectedNodeNetworkContainer	,
		0
	)

private

This class does not need a streamer as it is not supposed to be stored.

But for the base classes the streamer is needed for the case of parallel processing. For this reason the version is set to 0 which does actually this. It will not create the streamer for the data members of the DirectedNodeNetworkContainer itself but it still creates the streamers for the base classes. Just for reference: the previous class version was 10.

◆ clear()

void clear ( void )

inline

Clear directed node network container Called to clear the directed node network container if the segment network size grows to large.

This is necessary to prevent to following modules from processing events with a only partly filled network.

Definition at line 130 of file DirectedNodeNetworkContainer.h.

◆ copyRelations()

void copyRelations ( const RelationsInterface< BASE > * sourceObj )

inlineinherited

Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

Useful if you want to make a complete copy of a StoreArray object to make modifications to it, but retain all information on linked objects.

Note: this only works if sourceObj inherits from the same base (e.g. RelationsObject), and only for related objects that also inherit from the same base.

Definition at line 170 of file RelationsObject.h.

◆ getInfo()

std::string getInfo ( ) const

inlineinherited

Return a short summary of this object's contents in raw text format.

Returns the contents of getInfoHTML() while translating line-breaks etc.

Note: : You don't need to implement this function (it's not virtual), getInfoHTML() is enough.

Definition at line 370 of file RelationsObject.h.

◆ getInfoHTML()

virtual std::string getInfoHTML ( ) const

inlinevirtualinherited

Return a short summary of this object's contents in HTML format.

Reimplement this in your own class to provide useful output for display or debugging purposes. For example, you might do something like:

std::stringstream out;
out << "<b>PDG</b>: " << m_pdg << "<br>";
out << "<b>Covariance Matrix</b>: " << HTML::getString(getCovariance5()) << "<br>";
return out.str();

See also: Particle::getInfoHTML() for a more complex example.; HTML for some utility functions.; Use getInfo() to get a raw text version of this output.

Reimplemented in RecoTrack, TRGSummary, TrackFitResult, Track, SoftwareTriggerResult, PIDLikelihood, MCParticle, Cluster, and Particle.

Definition at line 362 of file RelationsObject.h.

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

Return a short name that describes this object, e.g.

pi+ for an MCParticle.

Reimplemented in SpacePoint, MCParticle, and Particle.

Definition at line 344 of file RelationsObject.h.

◆ getRelated()

T* getRelated	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object to or from which this object has a relation.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 278 of file RelationsObject.h.

◆ getRelatedFrom()

FROM* getRelatedFrom	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object from which this object has a relation.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 263 of file RelationsObject.h.

◆ getRelatedFromWithWeight()

std::pair<FROM*, float> getRelatedFromWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing from an array.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 314 of file RelationsObject.h.

◆ getRelatedTo()

TO* getRelatedTo	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object to which this object has a relation.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 248 of file RelationsObject.h.

◆ getRelatedToWithWeight()

std::pair<TO*, float> getRelatedToWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing to an array.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 297 of file RelationsObject.h.

◆ getRelatedWithWeight()

std::pair<T*, float> getRelatedWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing from/to an array.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 331 of file RelationsObject.h.

◆ getRelationsFrom()

RelationVector<FROM> getRelationsFrom	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations that point from another store array to this object.

Template Parameters

FROM	The class of objects from which the relations point.

Parameters

name	The name of the store array from which the relations point. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 212 of file RelationsObject.h.

◆ getRelationsTo()

RelationVector<TO> getRelationsTo	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations that point from this object to another store array.

Template Parameters

TO	The class of objects to which the relations point.

Parameters

name	The name of the store array to which the relations point. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 197 of file RelationsObject.h.

◆ getRelationsWith()

RelationVector<T> getRelationsWith	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations between this object and another store array.

Relations in both directions are returned.

Template Parameters

T	The class of objects to or from which the relations point.

Parameters

name	The name of the store array to or from which the relations point. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 230 of file RelationsObject.h.

Member Data Documentation

◆ m_ActiveSectorNetwork

DirectedNodeNetwork<ActiveSector<StaticSectorType, TrackNode>, Belle2::VoidMetaInfo> m_ActiveSectorNetwork

protected

************************* DATA MEMBERS *************************

Stores the full network of activeSectors, which contain hits in that event and have compatible Sectors with hits too

Definition at line 177 of file DirectedNodeNetworkContainer.h.

The documentation for this class was generated from the following file:

tracking/trackFindingVXD/segmentNetwork/include/DirectedNodeNetworkContainer.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ accessActiveSectorNetwork()

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ ClassDef()

◆ clear()

◆ copyRelations()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

Member Data Documentation

◆ m_ActiveSectorNetwork