Specialised SelectSubset<Particle> that also fixes daughter indices and all ParticleLists. More...

#include <ParticleSubset.h>

Inheritance diagram for ParticleSubset:

Collaboration diagram for ParticleSubset:

[legend]

Public Member Functions
void	removeParticlesNotInLists (const std::vector< std::string > &listNames)
	Removes all Particles that are not in one of the given ParticleLists (or daughters of Particles in the lists). More...

void	select (std::function< bool(const Particle *)> f)
	select Particles for which f returns true, discard others

void	registerSubset (const StoreArray< Particle > &set, DataStore::EStoreFlags storeFlags=DataStore::c_ErrorIfAlreadyRegistered)
	Remove all non-selected objects from set. More...

void	registerSubset (const StoreArray< Particle > &set, const std::string &subsetName, DataStore::EStoreFlags storeFlags=DataStore::c_ErrorIfAlreadyRegistered)
	Register the StoreArray<StoredClass> that will contain the subset of selected elements. More...

void	inheritRelationsFrom (const StoreArray< T > &array, MoreArguments... moreArgs)
	Inherit relations pointing from Other to objects selected into this subset. More...

void	inheritRelationsTo (const StoreArray< T > &array, MoreArguments... moreArgs)
	Inherit relations pointing from objects selected into this subset to Other. More...

void	inheritAllRelations ()
	Automatically inherit all relations to or from the original set (if registered when calling this function). More...

void	select (const std::function< bool(const Particle *)> &f)
	This method is the actual worker. More...

StoreAccessorBase *	getSet () override
	Get accessor for original set.

StoreAccessorBase *	getSubSet () override
	Get accessor for reduced set.

std::vector< std::string >	getInheritFromArrays () const
	Get list of arrays we inherit relations from.

std::vector< std::string >	getInheritToArrays () const
	Get list of arrays we inherit relations to.

bool	getInheritToSelf () const
	Do we inherit relations from original set to itself?

Protected Member Functions
void	fixParticles (const std::map< int, int > &oldToNewMap)
	fix daughter indices, reset m_arrayPointer

void	fixParticleLists (const std::map< int, int > &oldToNewMap)
	fix contents of particlelists by updating indices or removing entries.

void	inheritRelationsFrom ()
	Empty method to stop the recursion of the variadic template. More...

void	inheritRelationsTo ()
	Empty method to stop the recursion of the variadic template. More...

std::map< int, int >	copySetWithRelations (std::function< bool(const Particle *)> f)
	Selects the elements, fill the subset and copies all the relations in which the set is involved.

void	copyRelationsToSelf ()
	Copy any set -> set relations between selected objects.

void	swapSetsAndDestroyOriginal ()
	Swap set and subset (+relations), and keep only the reduced set. More...

Static Protected Member Functions
static void	fixVector (std::vector< int > &vec, const std::map< int, int > &oldToNewMap)
	replace entries in vec via oldToNewMap, removing those not found.

Protected Attributes
StoreArray< Particle > *	m_set
	The array we use as input.

StoreArray< Particle > *	m_subset
	The array we create.

DataStore::EStoreFlags	m_subsetFlags
	Flags used for m_subset.

std::vector< std::string >	m_inheritFromArrays
	array names we inherit relations from.

std::vector< std::string >	m_inheritToArrays
	array names we inherit relations to.

bool	m_inheritToSelf = false
	If true, relations from set objects to set objects are copied. More...

bool	m_reduceExistingSet = false
	If true, non-selected candidates are removed from m_set, m_subset only exists temporarily.

Detailed Description

Specialised SelectSubset<Particle> that also fixes daughter indices and all ParticleLists.

Relations are already handled in SelectSubset.

Can be used like SelectSubset via select(), or by calling removeParticlesNotInLists() instead.

Definition at line 15 of file ParticleSubset.h.

Member Function Documentation

◆ inheritAllRelations()

void inheritAllRelations

inlineinherited

Automatically inherit all relations to or from the original set (if registered when calling this function).

Equivalent to calling inheritRelationsFrom()/To() for all related arrays.

Note: Do not combine with inheritRelationsFrom() and inheritRelationsTo().

Definition at line 311 of file SelectSubset.h.

◆ inheritRelationsFrom() [1/2]

void inheritRelationsFrom

inlineprotectedinherited

Empty method to stop the recursion of the variadic template.

Definition at line 347 of file SelectSubset.h.

◆ inheritRelationsFrom() [2/2]

void inheritRelationsFrom	(	const StoreArray< T > &	array,
		MoreArguments...	moreArgs
	)

inlineinherited

Inherit relations pointing from Other to objects selected into this subset.

You can specify an unlimited number of arrays as arguments to this function.

Definition at line 260 of file SelectSubset.h.

◆ inheritRelationsTo() [1/2]

void inheritRelationsTo

inlineprotectedinherited

Empty method to stop the recursion of the variadic template.

Definition at line 349 of file SelectSubset.h.

◆ inheritRelationsTo() [2/2]

void inheritRelationsTo	(	const StoreArray< T > &	array,
		MoreArguments...	moreArgs
	)

inlineinherited

Inherit relations pointing from objects selected into this subset to Other.

You can specify an unlimited number of arrays as arguments to this function.

Definition at line 285 of file SelectSubset.h.

◆ registerSubset() [1/2]

void registerSubset	(	const StoreArray< Particle > &	set,
		const std::string &	subsetName,
		DataStore::EStoreFlags	storeFlags = `DataStore::c_ErrorIfAlreadyRegistered`
	)

inlineinherited

Register the StoreArray<StoredClass> that will contain the subset of selected elements.

Parameters

set	The StoreArray<StoredClass> from which the elements will be selected
subsetName	The name of the StoreArray<StoredClass> that will contain the selected elements
storeFlags	ORed combination of DataStore::EStoreFlags.

Definition at line 239 of file SelectSubset.h.

◆ registerSubset() [2/2]

void registerSubset	(	const StoreArray< Particle > &	set,
		DataStore::EStoreFlags	storeFlags = `DataStore::c_ErrorIfAlreadyRegistered`
	)

inlineinherited

Remove all non-selected objects from set.

All relations registered so far are retained. TODO: consider moving this into StoreArray itself

Parameters

set	The StoreArray<StoredClass> from which to retain only selected elements
storeFlags	flags used for temporary arrays and relations. Should be changed from the default if you want multiple instances. c_DontWriteOut is always used.

Definition at line 225 of file SelectSubset.h.

◆ removeParticlesNotInLists()

void removeParticlesNotInLists ( const std::vector< std::string > & listNames )

Removes all Particles that are not in one of the given ParticleLists (or daughters of Particles in the lists).

Removal is done immediately, there is no need to call select() afterwards.

Definition at line 21 of file ParticleSubset.cc.

 {
   std::unordered_set<int> indicesToKeep;
   for (const auto& l : listNames) {
     StoreObjPtr<ParticleList> list(l);
     if (!list)
       continue;
  
     if (list->getParticleCollectionName() == m_set->getName()) {
       const int n = list->getListSize();
       for (int i = 0; i < n; i++) {
         const Particle* p = list->getParticle(i);
         keepParticle(p, &indicesToKeep);
       }
     } else {
       B2ERROR("ParticleList " << l << " uses Particle array '" << list->getParticleCollectionName() <<
               "', but ParticleSubset uses different array '" << m_set->getName() << "'!");
     }
   }
  
   //remove everything not in indicesToKeep
   auto selector = [indicesToKeep](const Particle * p) -> bool {
     int idx = p->getArrayIndex();
     return indicesToKeep.count(idx) == 1;
   };
   select(selector);
 }

◆ select()

void select ( const std::function< bool(const Particle *)> & f )

inherited

This method is the actual worker.

It selects the elements, fill the subset and all the relations in which the subset is involved.

Parameters

f	the pointer to the function (or a nameless lambda expression) returning true for the elements to be selected and false for the others.

Definition at line 423 of file SelectSubset.h.

◆ swapSetsAndDestroyOriginal()

void swapSetsAndDestroyOriginal ( )

protectedinherited

Swap set and subset (+relations), and keep only the reduced set.

Subset and associated relations will be empty afterwards.

Definition at line 7 of file SelectSubset.cc.

 {
   StoreAccessorBase* set = getSet();
   StoreAccessorBase* subset = getSubSet();
  
   //replace set with subset
   DataStore::Instance().replaceData(*subset, *set);
  
   //swap relations
   for (const std::string& fromArray : m_inheritFromArrays) {
     RelationArray setRel(DataStore::relationName(fromArray, set->getName()));
     RelationArray subsetRel(DataStore::relationName(fromArray, subset->getName()));
     DataStore::Instance().replaceData(subsetRel, setRel);
   }
   for (const std::string& toArray : m_inheritToArrays) {
     RelationArray setRel(DataStore::relationName(set->getName(), toArray));
     RelationArray subsetRel(DataStore::relationName(subset->getName(), toArray));
     DataStore::Instance().replaceData(subsetRel, setRel);
   }
 }

Member Data Documentation

◆ m_inheritToSelf

bool m_inheritToSelf = false

protectedinherited

If true, relations from set objects to set objects are copied.

(if both objects are selected!).

Definition at line 68 of file SelectSubset.h.

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

analysis/utility/include/ParticleSubset.h
analysis/utility/src/ParticleSubset.cc

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ inheritAllRelations()

◆ inheritRelationsFrom() [1/2]

◆ inheritRelationsFrom() [2/2]

◆ inheritRelationsTo() [1/2]

◆ inheritRelationsTo() [2/2]

◆ registerSubset() [1/2]

◆ registerSubset() [2/2]

◆ removeParticlesNotInLists()

◆ select()

◆ swapSetsAndDestroyOriginal()

Member Data Documentation

◆ m_inheritToSelf