Handles particle selection criteria for data analysis classes ,.

A KVParticleCondition object can be used to select nuclei to include in data analysis (see KVEventSelector::SetParticleConditions()) or in the calculation of global variables (see KVVarGlob::SetSelection()). The Test() method returns true or false for a given nucleus depending on whether or not the condition is fulfilled. Combinations of selections can be performed using Boolean logic operations && and ||.

Lambda expressions were introduced in C++11 and provide an easy way to define small functions on the fly inside code. The lambda must take a const KVNucleus* pointer as argument and return a boolean:

KVParticleCondition l1("Z>2", [](const KVNucleus* nuc){ return nuc->GetZ()>2; });

KVParticleCondition l2("Vpar>0", [](const KVNucleus* nuc){ return nuc->GetVpar()>0; });

KVNucleus

Description of properties and kinematics of atomic nuclei.

Definition: KVNucleus.h:125

KVNucleus::GetZ

Int_t GetZ() const

Return the number of proton / atomic number.

Definition: KVNucleus.cpp:770

KVParticleCondition

Handles particle selection criteria for data analysis classes ,.

Definition: KVParticleCondition.h:64

KVParticle::GetVpar

Double_t GetVpar() const

Definition: KVParticle.h:636

Note the first argument to the constructor is a name which the user is free to define in order to remember what the condition does.

Like any lambda expressions, variables can be 'captured' from the surrounding scope, which can be useful in some situations. For example, given the following definitions:

int zmin = 3;

KVParticleCondition l3("Z>zmin", [&](const KVNucleus* nuc){ return nuc->GetZ()>=zmin; });

then the limit for the selection can be changed dynamically like so:

KVNucleus N("7Li");
l3.Test(&N);      ==> returns true
zmin=5;
l3.Test(&N);      ==> returns false

Examples: globvars_kvzmax.C.

Definition at line 64 of file KVParticleCondition.h.

Public Member Functions
	KVParticleCondition ()
	default ctor More...

	KVParticleCondition (const Char_t *cond)

	KVParticleCondition (const KVParticleCondition &)
	Copy constructor. Create new condition which is a copy of existing condition, obj. More...

	KVParticleCondition (const KVString &cond)

	KVParticleCondition (const KVString &name, const LambdaFunc &F)

virtual	~KVParticleCondition ()
	default dtor More...

void	AddExtraInclude (const Char_t *inc_file)

void	Copy (TObject &) const
	Copy this to obj. More...

bool	IsLambda () const

Bool_t	IsSet () const

KVParticleCondition &	operator&= (const KVParticleCondition &)

KVParticleCondition &	operator= (const KVParticleCondition &)
	Set condition to be same as for existing KVParticleCondition object. More...

KVParticleCondition &	operator= (const KVString &)

KVParticleCondition &	operator= (const LambdaFunc &)
	Set condition using lambda expression (replacing any previous definition). More...

KVParticleCondition &	operator\|= (const KVParticleCondition &)

void	Print (Option_t *opt="") const
	Print informations on object. More...

void	Set (const KVString &)

void	Set (const KVString &name, const LambdaFunc &F)

void	SetParticleClassName (const Char_t *cl)

Bool_t	Test (const KVNucleus &nuc) const

Bool_t	Test (const KVNucleus *nuc) const

Public Member Functions inherited from KVBase
	KVBase ()
	Default constructor. More...

	KVBase (const Char_t name, const Char_t title="")
	Ctor for object with given name and type. More...

	KVBase (const KVBase &)
	copy ctor More...

virtual	~ KVBase ()

virtual void	Clear (Option_t *opt="")
	Clear object properties : name, type/title, number, label. More...

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

const Char_t *	GetType () const

Bool_t	HasLabel () const

virtual Bool_t	IsCalled (const Char_t *name) const

Bool_t	IsLabelled (const Char_t *l) const

virtual Bool_t	IsType (const Char_t *typ) const

virtual void	List ()

KVBase &	operator= (const KVBase &)
	copy assignment operator More...

Double_t	ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()

virtual TObject *	Clone (const char *newname="") const

virtual Int_t	Compare (const TObject *obj) const

virtual void	FillBuffer (char *&buffer)

virtual const char *	GetName () const

virtual const char *	GetTitle () const

virtual ULong_t	Hash () const

virtual Bool_t	IsSortable () const

virtual void	ls (Option_t *option="") const

TNamed &	operator= (const TNamed &rhs)

virtual void	SetName (const char *name)

virtual void	SetNameTitle (const char name, const char title)

virtual void	SetTitle (const char *title="")

virtual Int_t	Sizeof () const

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)

virtual	~TObject ()

void	AbstractMethod (const char *method) const

virtual void	AppendPad (Option_t *option="")

virtual void	Browse (TBrowser *b)

ULong_t	CheckedHash ()

virtual const char *	ClassName () const

virtual void	Delete (Option_t *option="")

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)

virtual void	Draw (Option_t *option="")

virtual void	DrawClass () const

virtual TObject *	DrawClone (Option_t *option="") const

virtual void	Dump () const

virtual void	Error (const char method, const char msgfmt,...) const

virtual void	Execute (const char method, const char params, Int_t *error=0)

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)

virtual void	Fatal (const char method, const char msgfmt,...) const

virtual TObject *	FindObject (const char *name) const

virtual TObject *	FindObject (const TObject *obj) const

virtual Option_t *	GetDrawOption () const

virtual const char *	GetIconName () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const

virtual Bool_t	HandleTimer (TTimer *timer)

Bool_t	HasInconsistentHash () const

virtual void	Info (const char method, const char msgfmt,...) const

virtual Bool_t	InheritsFrom (const char *classname) const

virtual Bool_t	InheritsFrom (const TClass *cl) const

virtual void	Inspect () const

void	InvertBit (UInt_t f)

virtual Bool_t	IsEqual (const TObject *obj) const

virtual Bool_t	IsFolder () const

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const

virtual Bool_t	Notify ()

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const

void	operator delete (void *ptr)

void	operator delete[] (void *ptr)

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)

virtual void	Paint (Option_t *option="")

virtual void	Pop ()

virtual Int_t	Read (const char *name)

virtual void	RecursiveRemove (TObject *obj)

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)

virtual void	SetDrawOption (Option_t *option="")

virtual void	SetUniqueID (UInt_t uid)

virtual void	SysError (const char method, const char msgfmt,...) const

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()

virtual void	Warning (const char method, const char msgfmt,...) const

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const

Static Public Member Functions
static void	PrintOptimizedList ()

Static Public Member Functions inherited from KVBase
static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values. More...

static void	BackupFileWithDate (const Char_t *path)

static void	CombineFiles (const Char_t file1, const Char_t file2, const Char_t *newfilename, Bool_t keep=kTRUE)

static void	Deprecated (const char method, const char advice)

static Bool_t	FindClassSourceFiles (const Char_t class_name, KVString &imp_file, KVString &dec_file, const Char_t dir_name=".")

static Bool_t	FindExecutable (TString &exec, const Char_t *path="$(PATH)")

static const Char_t *	FindFile (const Char_t *search, TString &wfil)

static const Char_t *	GetBINDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetDATABASEFilePath ()

static const Char_t *	GetDATADIRFilePath (const Char_t *namefile="")

static Bool_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Bool_t defval)

static const Char_t *	GetDataSetEnv (const Char_t dataset, const Char_t type, const Char_t *defval)

static Double_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Double_t defval)

static const Char_t *	GetETCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetExampleFilePath (const Char_t library, const Char_t namefile)
	Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...

static const Char_t *	GetINCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetKVBuildDate ()
	Returns KaliVeda build date. More...

static const Char_t *	GetKVBuildDir ()
	Returns top-level directory used for build. More...

static const Char_t *	GetKVBuildTime ()
	Returns KaliVeda build date. More...

static const Char_t *	GetKVBuildType ()
	Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...

static const Char_t *	GetKVBuildUser ()
	Returns username of person who performed build. More...

static const Char_t *	GetKVSourceDir ()
	Returns top-level directory of source tree used for build. More...

static const Char_t *	GetKVVersion ()
	Returns KaliVeda version string. More...

static const Char_t *	GetLIBDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

static const Char_t *	GetPluginURI (const Char_t base, const Char_t plugin)

static void	GetTempFileName (TString &base)

static const Char_t *	GetTEMPLATEDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetWORKDIRFilePath (const Char_t *namefile="")

static const Char_t *	gitBranch ()
	Returns git branch of sources. More...

static const Char_t *	gitCommit ()
	Returns last git commit of sources. More...

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsThisAPlugin (const TString &uri, TString &base)

static TPluginHandler *	LoadPlugin (const Char_t base, const Char_t uri="0")

static Bool_t	OpenContextMenu (const char method, TObject obj, const char *alt_method_name="")

static void	OpenTempFile (TString &base, std::ofstream &fp)

static void	PrintSplashScreen ()
	Prints welcome message and infos on version etc. More...

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ifstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ofstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchKVFile (const Char_t name, TString &fullpath, const Char_t kvsubdir="")

static const Char_t *	WorkingDirectory ()

Static Public Member Functions inherited from TObject
static Longptr_t	GetDtorOnly ()

static Bool_t	GetObjectStat ()

static void	SetDtorOnly (void *obj)

static void	SetObjectStat (Bool_t stat)

Protected Member Functions
void	CreateClassFactory () const
	Initialises KVClassFactory object used for optimization if it doesn't exist. More...

void	Optimize () const

virtual bool	optimized_test (const KVNucleus *) const

void	SetClassFactory (KVClassFactory *CF)

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const

void	MakeZombie ()

Protected Attributes
KVClassFactory *	cf
	used to generate code for optimisation More...

KVString	fClassName

KVString	fCondition
	string containing selection criteria with ";" at end More...

KVString	fCondition_brackets
	condition with '(' and ')' around it More...

KVString	fCondition_raw
	'raw' condition, i.e. no ';' More...

const KVParticleCondition *	fOptimal

KVString	fOptimizedClassName
	name of generated class used for optimisation More...

Bool_t	fOptOK
	false if optimisation failed (can't load generated code) More...

Protected Attributes inherited from KVBase
TString	fLabel
	label for the object More...

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TObject
	kOnlyPrepStep

Private Types
using	LambdaFunc = std::function< bool(const KVNucleus *)>

enum class	LogOp { AND , OR }

Private Member Functions
void	logical_operator_lambda_condition_test () const

Private Attributes
LambdaFunc	fLambdaCondition

Int_t	fNUsing
	number of classes using this as an optimized condition More...

enum KVParticleCondition::LogOp	fOpType

LambdaFunc	fSavedLambda1

LambdaFunc	fSavedLambda2
	used by \|\| and && More...

Static Private Attributes
static KVHashList	fgOptimized
	list of optimized particle conditions More...

Friends
KVParticleCondition	operator&& (const KVParticleCondition &, const KVParticleCondition &)

KVParticleCondition	operator\|\| (const KVParticleCondition &, const KVParticleCondition &)

Additional Inherited Members
Public Types inherited from KVBase
enum	EKaliVedaBits { kIsKaliVedaObject = BIT(23) }

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

Public Attributes inherited from TObject
	kBitMask

	kCanDelete

	kCannotPick

	kHasUUID

	kInconsistent

	kInvalidObject

	kIsOnHeap

	kIsReferenced

	kMustCleanup

	kNoContextMenu

	kNotDeleted

	kObjInCanvas

	kOverwrite

	kSingleKey

	kWriteDelete

	kZombie

#include <KVParticleCondition.h>

Inheritance diagram for KVParticleCondition:

[legend]

Member Typedef Documentation

◆ LambdaFunc

using KVParticleCondition::LambdaFunc = std::function<bool(const KVNucleus*)>

private

Definition at line 68 of file KVParticleCondition.h.

Member Enumeration Documentation

◆ LogOp

enum KVParticleCondition::LogOp

strongprivate

Enumerator
AND
OR

Definition at line 71 of file KVParticleCondition.h.

Constructor & Destructor Documentation

◆ KVParticleCondition() [1/5]

KVParticleCondition::KVParticleCondition ( )

default ctor

Definition at line 160 of file KVParticleCondition.cpp.

◆ KVParticleCondition() [2/5]

KVParticleCondition::KVParticleCondition ( const KVString & cond )

Create named object and set condition. This must be a valid C++ expression using _NUC_ instead and in place of a const KVNucleus* pointer to the particle to be tested, for example

KVParticleCondition c1("_NUC_->GetZ()>2");

KVParticleCondition c2("_NUC_->GetVpar()>0");

c1

return c1

c2

return c2

Note that the methods used in the selection do not have to be limited to the methods of the KVNucleus class. The 'real' class of the object passed to Test() can be used to cast the base pointer up (or is it down?) to the required pointer type at execution. In this case, you must call the method SetParticleClassName() with the name of the class to use in the cast.

Note that the first call to Test() automatically causes the 'optimization' of the KVParticleCondition, which means that a class implementing the required condition is generated and compiled on the fly before continuing (see method Optimize()).

Definition at line 80 of file KVParticleCondition.cpp.

◆ KVParticleCondition() [3/5]

KVParticleCondition::KVParticleCondition ( const Char_t * cond )

Create named object and set condition. This must be a valid C++ expression using _NUC_ instead and in place of a const KVNucleus* pointer to the particle to be tested, for example

KVParticleCondition c1("_NUC_->GetZ()>2");

KVParticleCondition c2("_NUC_->GetVpar()>0");

Note that the methods used in the selection do not have to be limited to the methods of the KVNucleus class. The 'real' class of the object passed to Test() can be used to cast the base pointer up (or is it down?) to the required pointer type at execution. In this case, you must call the method SetParticleClassName() with the name of the class to use in the cast.

Note that the first call to Test() automatically causes the 'optimization' of the KVParticleCondition, which means that a class implementing the required condition is generated and compiled on the fly before continuing (see method Optimize()).

Definition at line 128 of file KVParticleCondition.cpp.

◆ KVParticleCondition() [4/5]

KVParticleCondition::KVParticleCondition ( const KVParticleCondition & obj )

Copy constructor. Create new condition which is a copy of existing condition, obj.

Definition at line 240 of file KVParticleCondition.cpp.

◆ KVParticleCondition() [5/5]

KVParticleCondition::KVParticleCondition	(	const KVString &	name,
		const LambdaFunc &	F
	)

inline

Create named object using lambda expression for condition The lambda must take a const KVNucleus* pointer as argument and return a boolean:

KVParticleCondition l1("Z>2", [](const KVNucleus* nuc){ return nuc->GetZ()>2; });

KVParticleCondition l2("Vpar>0", [](const KVNucleus* nuc){ return nuc->GetVpar()>0; });

Note the first argument to the constructor is a name which the user is free to define in order to remember what the condition does.

Like any lambda expressions, variables can be 'captured' from the surrounding scope, which can be useful in some situations. For example, given the following definitions:

int zmin = 3;

KVParticleCondition l3("Z>zmin", [&](const KVNucleus* nuc){ return nuc->GetZ()>=zmin; });

then the limit for the selection can be changed dynamically like so:

KVNucleus N("7Li");
l3.Test(&N); ==> returns true
zmin=5;
l3.Test(&N); ==> returns false

Definition at line 120 of file KVParticleCondition.h.

◆ ~KVParticleCondition()

KVParticleCondition::~KVParticleCondition ( )

virtual

default dtor

KVParticleCondition(KVParticleCondition&& other) noexcept; KVParticleCondition& operator=(KVParticleCondition&& other) noexcept;

Definition at line 175 of file KVParticleCondition.cpp.

Member Function Documentation

◆ AddExtraInclude()

void KVParticleCondition::AddExtraInclude ( const Char_t * inc_file )

Optimisation of KVParticleCondition::Test() implies the automatic generation of a new class which implements the selection required by the user (see Optimize()).

If the user's condition depends on objects of classes other than the family of particle classes (TLorentVector <- KVParticle <- KVNucleus ...) there will not be by default the necessary '#include' directive for the classes in question in the generated class; the required plugin for Test() to function will not load. In this case, the user should call this method with the name of each '#include' file to be added to the class implementation.

Example:

KVParticleCondition p("_NUC_->GetVpar()>=gDataAnalyser->GetKinematics()->GetNucleus(1)->GetVpar()");

Optimization will not work, as:

gDataAnalyser pointer to current analysis manager (KVDataAnalyser object), defined in KVDataAnalyser.h
gDataAnalyser->GetKinematics() returns a pointer to a KV2Body object, defined in KV2Body.h

Therefore, for this condition to work, the user must first call the methods :

p.AddExtraInclude("KVDataAnalyser.h");

p.AddExtraInclude("KV2Body.h");

before the first call to p.Test() (when optimization occurs).

Definition at line 590 of file KVParticleCondition.cpp.

◆ Copy()

void KVParticleCondition::Copy ( TObject & obj ) const

virtual

Copy this to obj.

Reimplemented from KVBase.

Definition at line 196 of file KVParticleCondition.cpp.

◆ CreateClassFactory()

void KVParticleCondition::CreateClassFactory ( ) const

protected

Initialises KVClassFactory object used for optimization if it doesn't exist.

Definition at line 629 of file KVParticleCondition.cpp.

◆ IsLambda()

bool KVParticleCondition::IsLambda ( ) const

inline

Returns: true if this condition is defined using a lambda expression

Definition at line 151 of file KVParticleCondition.h.

◆ IsSet()

Bool_t KVParticleCondition::IsSet ( ) const

inline

Return kTRUE if a condition/selection has been defined

If this is not true, Test() will return true for all and any nuclei.

Definition at line 237 of file KVParticleCondition.h.

◆ logical_operator_lambda_condition_test()

void KVParticleCondition::logical_operator_lambda_condition_test ( ) const

inlineprivate

check if we were created by && or || and haven't been initialized yet

Definition at line 73 of file KVParticleCondition.h.

◆ operator&=()

KVParticleCondition & KVParticleCondition::operator&= ( const KVParticleCondition & other )

Replace current condition with a logical 'AND' between itself and other

Both conditions must be of same type, i.e. if one uses a lambda expression, the other must also use a lambda expression.

Definition at line 547 of file KVParticleCondition.cpp.

◆ operator=() [1/3]

KVParticleCondition & KVParticleCondition::operator= ( const KVParticleCondition & obj )

Set condition to be same as for existing KVParticleCondition object.

Definition at line 257 of file KVParticleCondition.cpp.

◆ operator=() [2/3]

KVParticleCondition & KVParticleCondition::operator= ( const KVString & sel )

Set condition using pseudo-code in string (replacing any previous definition).

This must be a valid C++ expression using _NUC_ instead and in place of a const KVNucleus* pointer to the particle to be tested, for example

KVParticleCondition c1("_NUC_->GetZ()>2");

KVParticleCondition c2("_NUC_->GetVpar()>0");

Note that the methods used in the selection do not have to be limited to the methods of the KVNucleus class. The 'real' class of the object passed to Test() can be used to cast the base pointer up (or is it down?) to the required pointer type at execution. In this case, you must call the method SetParticleClassName() with the name of the class to use in the cast.

Definition at line 283 of file KVParticleCondition.cpp.

◆ operator=() [3/3]

KVParticleCondition & KVParticleCondition::operator= ( const LambdaFunc & f )

Set condition using lambda expression (replacing any previous definition).

Definition at line 345 of file KVParticleCondition.cpp.

◆ operator|=()

KVParticleCondition & KVParticleCondition::operator|= ( const KVParticleCondition & other )

Replace current condition with a logical 'OR' between itself and other

Both conditions must be of same type, i.e. if one uses a lambda expression, the other must also use a lambda expression.

Definition at line 527 of file KVParticleCondition.cpp.

◆ Optimize()

void KVParticleCondition::Optimize ( ) const

protected

Generate a new class which inherits from KVParticleCondition but having a Test() method which tests explicitly the condition which is set by the user.

If needed, the KVNucleus pointer argument will be upcasted to the type given to SetParticleClassName().

The new class is added to the list of plugins of type KVParticleCondition, then an instance of the class is generated and a pointer to it stored in member KVParticleCondition::fOptimal.

This object is then used in the Test() method of this object to test the condition.

If compilation fails, the condition will evaluate to kFALSE for all subsequent calls.

Definition at line 663 of file KVParticleCondition.cpp.

◆ optimized_test()

virtual bool KVParticleCondition::optimized_test ( const KVNucleus * ) const

inlineprotectedvirtual

Definition at line 106 of file KVParticleCondition.h.

◆ Print()

void KVParticleCondition::Print ( Option_t * opt = "" ) const

virtual

Print informations on object.

Reimplemented from KVBase.

Definition at line 759 of file KVParticleCondition.cpp.

◆ PrintOptimizedList()

static void KVParticleCondition::PrintOptimizedList ( )

inlinestatic

Definition at line 233 of file KVParticleCondition.h.

◆ Set() [1/2]

void KVParticleCondition::Set ( const KVString & cond )

Set particle condition criteria.

These must be valid C++ expressions using NUC instead and in place of a pointer to the particle to be tested. Note that the methods used in the selection do not have to be limited to the KVNucleus class. The 'real' class of the object passed to Test() will be used to cast the base (KVNucleus) pointer up to the required pointer type at execution.

Definition at line 35 of file KVParticleCondition.cpp.

◆ Set() [2/2]

void KVParticleCondition::Set	(	const KVString &	name,
		const LambdaFunc &	F
	)

inline

Set condition using lambda expression (replace any existing definition).

The lambda must take a const KVNucleus* pointer as argument and return a boolean:

KVParticleCondition l1("Z>2", [](const KVNucleus* nuc){ return nuc->GetZ()>2; });

KVParticleCondition l2("Vpar>0", [](const KVNucleus* nuc){ return nuc->GetVpar()>0; });

Note the first argument to the constructor is a name which the user is free to define in order to remember what the condition does.

Definition at line 161 of file KVParticleCondition.h.

◆ SetClassFactory()

void KVParticleCondition::SetClassFactory ( KVClassFactory * CF )

protected

PRIVATE METHOD Used by Copy

Definition at line 226 of file KVParticleCondition.cpp.

◆ SetParticleClassName()

void KVParticleCondition::SetParticleClassName ( const Char_t * cl )

inline

Definition at line 214 of file KVParticleCondition.h.

◆ Test() [1/2]

Bool_t KVParticleCondition::Test ( const KVNucleus & nuc ) const

inline

Evaluates the condition for the particle in question

If no condition has been set (object created with default ctor) this returns kTRUE for all nuclei.

If optimisation fails (see method Optimize()), the condition will always be evaluated as 'kFALSE' for all particles

Definition at line 201 of file KVParticleCondition.h.

◆ Test() [2/2]

Bool_t KVParticleCondition::Test ( const KVNucleus * nuc ) const

inline

Evaluates the condition for the particle in question

If no condition has been set (object created with default ctor) this returns kTRUE for all nuclei.

If optimisation fails (see method Optimize()), the condition will always be evaluated as 'kFALSE' for all particles

Definition at line 179 of file KVParticleCondition.h.

Friends And Related Function Documentation

◆ operator&&

KVParticleCondition operator&&	(	const KVParticleCondition &	A,
		const KVParticleCondition &	B
	)

friend

Perform boolean AND between the two selection conditions

If SetParticleClassName() has been called for either of the two conditions, it will be called for the resulting condition with the same value

Both conditions must be of same type, i.e. if one uses a lambda expression, the other must also use a lambda expression.

If one or other of the conditions is not set, we just return the condition which has been set.

Definition at line 406 of file KVParticleCondition.cpp.

◆ operator||

KVParticleCondition operator\|\|	(	const KVParticleCondition &	A,
		const KVParticleCondition &	B
	)

friend

Perform boolean OR between the two selection conditions

If SetParticleClassName has been called for either of the two conditions, it will be called for the resulting condition with the same value

Both conditions must be of same type, i.e. if one uses a lambda expression, the other must also use a lambda expression.

If one or other of the conditions is not set, we just return the condition which has been set.

Definition at line 470 of file KVParticleCondition.cpp.

Member Data Documentation

◆ cf

KVClassFactory* KVParticleCondition::cf

mutableprotected

used to generate code for optimisation

Definition at line 101 of file KVParticleCondition.h.

◆ fClassName

KVString KVParticleCondition::fClassName

protected

Definition at line 100 of file KVParticleCondition.h.

◆ fCondition

KVString KVParticleCondition::fCondition

protected

string containing selection criteria with ";" at end

Definition at line 95 of file KVParticleCondition.h.

◆ fCondition_brackets

KVString KVParticleCondition::fCondition_brackets

protected

condition with '(' and ')' around it

Definition at line 97 of file KVParticleCondition.h.

◆ fCondition_raw

KVString KVParticleCondition::fCondition_raw

protected

'raw' condition, i.e. no ';'

Definition at line 96 of file KVParticleCondition.h.

◆ fgOptimized

KVHashList KVParticleCondition::fgOptimized

staticprivate

list of optimized particle conditions

Definition at line 65 of file KVParticleCondition.h.

◆ fLambdaCondition

LambdaFunc KVParticleCondition::fLambdaCondition

mutableprivate

Definition at line 69 of file KVParticleCondition.h.

◆ fNUsing

Int_t KVParticleCondition::fNUsing

mutableprivate

number of classes using this as an optimized condition

Definition at line 66 of file KVParticleCondition.h.

◆ fOptimal

const KVParticleCondition* KVParticleCondition::fOptimal

mutableprotected

Definition at line 99 of file KVParticleCondition.h.

◆ fOptimizedClassName

KVString KVParticleCondition::fOptimizedClassName

protected

name of generated class used for optimisation

Definition at line 102 of file KVParticleCondition.h.

◆ fOptOK

Bool_t KVParticleCondition::fOptOK

mutableprotected

false if optimisation failed (can't load generated code)

Definition at line 103 of file KVParticleCondition.h.

◆ fOpType

enum KVParticleCondition::LogOp KVParticleCondition::fOpType

private

◆ fSavedLambda1

LambdaFunc KVParticleCondition::fSavedLambda1

private

Definition at line 70 of file KVParticleCondition.h.

◆ fSavedLambda2

LambdaFunc KVParticleCondition::fSavedLambda2

private

used by || and &&

Definition at line 70 of file KVParticleCondition.h.

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

kaliveda.doxygen/KVMultiDet/particles/KVParticleCondition.h
kaliveda.doxygen/KVMultiDet/particles/KVParticleCondition.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ LambdaFunc

Member Enumeration Documentation

◆ LogOp

Constructor & Destructor Documentation

◆ KVParticleCondition() [1/5]

◆ KVParticleCondition() [2/5]

◆ KVParticleCondition() [3/5]

◆ KVParticleCondition() [4/5]

◆ KVParticleCondition() [5/5]

◆ ~KVParticleCondition()

Member Function Documentation

◆ AddExtraInclude()

◆ Copy()

◆ CreateClassFactory()

◆ IsLambda()

◆ IsSet()

◆ logical_operator_lambda_condition_test()

◆ operator&=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator|=()

◆ Optimize()

◆ optimized_test()

◆ Print()

◆ PrintOptimizedList()

◆ Set() [1/2]

◆ Set() [2/2]

◆ SetClassFactory()

◆ SetParticleClassName()

◆ Test() [1/2]

◆ Test() [2/2]

Friends And Related Function Documentation

◆ operator&&

◆ operator||

Member Data Documentation

◆ cf

◆ fClassName

◆ fCondition

◆ fCondition_brackets

◆ fCondition_raw

◆ fgOptimized

◆ fLambdaCondition

◆ fNUsing

◆ fOptimal

◆ fOptimizedClassName

◆ fOptOK

◆ fOpType

◆ fSavedLambda1

◆ fSavedLambda2