Detailed Description

Signal output from a mathematical combination of other signals.

Created by KVClassFactory on Thu Jun 20 15:36:03 2019 Author: John Frankland,,,

Detector signals (see KVDetectorSignal) can be combined in mathematical expressions in order to define new signals - these are KVDetectorSignalExpression objects. See TFormula for valid mathematical operators, functions, etc.

Example of use

 KVDetector det;
 auto A = det.AddDetectorSignal("A");
 auto B = det.AddDetectorSignal("B");
 
 det.AddDetectorSignalExpression("C", "2*A+TMath::Sqrt(B)");
 
 A->SetValue(6);
 B->SetValue(16);
 
 det.GetDetectorSignalValue("C")
 (double) 16.000000
 
det.GetListOfDetectorSignals().ls()
OBJ: KVUniqueNameList   KVSeqCollection_156  Optimised list in which objects with the same name can only be placed once : 0
 KVDetectorSignal        A        Signal A of detector Det_1       [6.000000]
 KVDetectorSignal        B        Signal B of detector Det_1       [16.000000]
 KVDetectorSignalExpression       C        Signal calculated as 2*A+TMath::Sqrt(B) for detector Det_1        [16.000000]

Definition at line 42 of file KVDetectorSignalExpression.h.

#include <KVDetectorSignalExpression.h>

Inheritance diagram for KVDetectorSignalExpression:

[legend]

Public Member Functions
	KVDetectorSignalExpression (const Char_t type, const KVString &_expr, const KVSeqCollection dets)

KVString	GetExpression () const

Double_t	GetValue (const KVNameValueList &params="") const

Bool_t	IsExpression () const

Bool_t	IsRaw () const

Bool_t	IsValid () const

void	SetValue (Double_t)

Public Member Functions inherited from KVDetectorSignal
	KVDetectorSignal ()

	KVDetectorSignal (const Char_t type, const KVDetector det=nullptr)

virtual	~KVDetectorSignal ()

void	Clear (Option_t *="")

const KVDetector *	GetDetector () const

TString	GetFullName () const

virtual Double_t	GetInverseValue (Double_t out_val, const TString &in_sig, const KVNameValueList &params="") const

virtual Int_t	GetStatus (const TString &) const
	Override in child classes to report on the 'status' of the signal. More...

const Char_t *	GetType () const

virtual Bool_t	GetValueNeedsExtraParameters () const

virtual Bool_t	IsAvailableFor (const KVNameValueList &) const

Bool_t	IsFired () const

void	ls (Option_t *="") const
	Print compact listing of infos on signal: name/type, associated detector, value. More...

virtual void	Reset ()

void	SetDetector (const KVDetector *d)

void	SetFired (Bool_t yes=true)

void	SetType (const Char_t *typ)

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	Copy (TObject &) const
	Make a copy of this object. More...

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () 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...

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

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)

Private Member Functions
	KVDetectorSignalExpression (const Char_t type, const KVString &_expr, KVDetector det)

Private Attributes
std::unique_ptr< TFormula >	fFormula

Bool_t	fRaw

std::vector< KVDetectorSignal * >	fSignals

Bool_t	fValid

Friends
class	KVDetector

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

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 time. 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, KVSQLite::database &dbfile, const Char_t kvsubdir="")

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 ()

Constructor & Destructor Documentation

◆ KVDetectorSignalExpression() [1/2]

KVDetectorSignalExpression::KVDetectorSignalExpression	(	const Char_t *	type,
		const KVString &	_expr,
		KVDetector *	det
	)

private

Parameters

[in]	type	the typename for this expression, will be used as an alias for the expression
[in]	_expr	a mathematical expression using names of signals already defined for detector det. See TFormula class for valid operators/functions.
[in]	det	the detector to which this expression is to be associated

If no valid signals are contained in the expression (i.e. signals not already defined for the detector det), IsValid() returns kFALSE and the expression should not be used

Definition at line 19 of file KVDetectorSignalExpression.cpp.

◆ KVDetectorSignalExpression() [2/2]

KVDetectorSignalExpression::KVDetectorSignalExpression	(	const Char_t *	type,
		const KVString &	_expr,
		const KVSeqCollection *	dets
	)

Constructor to be used with expressions which use explict references to detector signals in the form [DET]::[SIG] where [DET] is the detector label and [SIG] is the signal name. The list must contain the detectors whose labels are referenced.

Note: any signals which are not defined will be systematically evaluated as zero

Parameters

[in]	type	the typename for this expression, will be used as an alias for the expression
[in]	_expr	a mathematical expression using explicit references to names of detector signals
[in]	dets	a list of pointers to the detectors whose signals are to be used in the expression

Definition at line 67 of file KVDetectorSignalExpression.cpp.

Member Function Documentation

◆ GetExpression()

KVString KVDetectorSignalExpression::GetExpression ( ) const

inline

Returns: the mathematical expression used to define this signal

Definition at line 75 of file KVDetectorSignalExpression.h.

◆ GetValue()

Double_t KVDetectorSignalExpression::GetValue ( const KVNameValueList & params = "" ) const

virtual

Parameters

[in] params comma-separated list of "param=value" pairs if extra parameters are required to evaluate any signals in the expression

Returns: value of the expression using all current values of signals

Reimplemented from KVDetectorSignal.

Definition at line 157 of file KVDetectorSignalExpression.cpp.

◆ IsExpression()

Bool_t KVDetectorSignalExpression::IsExpression ( ) const

inlinevirtual

Returns: kTRUE, obviously

Reimplemented from KVDetectorSignal.

Definition at line 65 of file KVDetectorSignalExpression.h.

◆ IsRaw()

Bool_t KVDetectorSignalExpression::IsRaw ( ) const

inlinevirtual

Returns: kFALSE as this is not a raw data parameter, in the sense that it should not be used to decide whether the detector fired in the last read raw data

Reimplemented from KVDetectorSignal.

Definition at line 59 of file KVDetectorSignalExpression.h.

◆ IsValid()

Bool_t KVDetectorSignalExpression::IsValid ( ) const

inlinevirtual

Returns: kTRUE if the expression is valid (all signals are known and all mathematical operations are understood by TFormula)

Reimplemented from KVDetectorSignal.

Definition at line 54 of file KVDetectorSignalExpression.h.

◆ SetValue()

void KVDetectorSignalExpression::SetValue ( Double_t )

inlinevirtual

Has no effect for an expression: its value cannot be set, only evaluated.

Reimplemented from KVDetectorSignal.

Definition at line 70 of file KVDetectorSignalExpression.h.

Friends And Related Function Documentation

◆ KVDetector

friend class KVDetector

friend

Definition at line 44 of file KVDetectorSignalExpression.h.

Member Data Documentation

◆ fFormula

std::unique_ptr<TFormula> KVDetectorSignalExpression::fFormula

private

Definition at line 46 of file KVDetectorSignalExpression.h.

◆ fRaw

Bool_t KVDetectorSignalExpression::fRaw

private

Definition at line 49 of file KVDetectorSignalExpression.h.

◆ fSignals

std::vector<KVDetectorSignal*> KVDetectorSignalExpression::fSignals

private

Definition at line 47 of file KVDetectorSignalExpression.h.

◆ fValid

Bool_t KVDetectorSignalExpression::fValid

private

Definition at line 48 of file KVDetectorSignalExpression.h.

Detailed Description

Example of use

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVDetectorSignalExpression() [1/2]

◆ KVDetectorSignalExpression() [2/2]

Member Function Documentation

◆ GetExpression()

◆ GetValue()

◆ IsExpression()

◆ IsRaw()

◆ IsValid()

◆ SetValue()

Friends And Related Function Documentation

◆ KVDetector

Member Data Documentation

◆ fFormula

◆ fRaw

◆ fSignals

◆ fValid