KaliVeda  1.13/01
Heavy-Ion Analysis Toolkit
List of all members | Public Member Functions | Private Attributes | List of all members
KVZDependentCalibratedSignal Class Reference

Handle several calibrations valid for different Z ranges.

Created by KVClassFactory on Wed Nov 6 17:35:31 2019 Author: John Frankland,,,

If 2 or more calibrations which define the same SignalOut have a ZRange parameter:

calib1.dat:
SignalOut: Energy
ZRange: 1-5
calib2.dat:
SignalOut: Energy
ZRange: 6-92

a single Energy signal object of this class will be added to the concerned detectors, it will handle switching between the calibrators when GetValue() etc. are called with a "Z=..." parameter in the KVNameValueList argument.

Definition at line 33 of file KVZDependentCalibratedSignal.h.

Public Member Functions

 KVZDependentCalibratedSignal ()
 
 KVZDependentCalibratedSignal (KVDetectorSignal *input, const KVString &output)
 
virtual ~KVZDependentCalibratedSignal ()
 
void AddSignal (KVCalibratedSignal *sig, const KVNumberList &zrange)
 Add signal to be used for all values of Z in the number list range. More...
 
Double_t GetInverseValue (Double_t out_val, const TString &in_sig, const KVNameValueList &params="") const
 
KVCalibratedSignalGetSignal (const KVNameValueList &params) const
 
Double_t GetValue (const KVNameValueList &params="") const
 
Bool_t GetValueNeedsExtraParameters () const
 
Bool_t IsAvailableFor (const KVNameValueList &params) const
 
- Public Member Functions inherited from KVCalibratedSignal
 KVCalibratedSignal ()
 
virtual ~KVCalibratedSignal ()
 
KVCalibratorGetCalibrator () const
 
KVDetectorSignalGetInputSignal () const
 
Bool_t InversionFailure () const
 
Bool_t IsRaw () const
 
- Public Member Functions inherited from KVDetectorSignal
 KVDetectorSignal ()
 
 KVDetectorSignal (const Char_t *type, const KVDetector *det=nullptr)
 
virtual ~KVDetectorSignal ()
 
void Clear (Option_t *="")
 Clear object properties : name, type/title, number, label. More...
 
const KVDetectorGetDetector () const
 
TString GetFullName () const
 
virtual Int_t GetStatus (const TString &) const
 Override in child classes to report on the 'status' of the signal. More...
 
const Char_tGetType () const
 
virtual Bool_t IsExpression () const
 
Bool_t IsFired () const
 
virtual Bool_t IsValid () 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)
 
virtual void SetValue (Double_t x)
 
- 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_tGetLabel () const
 
UInt_t GetNumber () const
 
UInt_t GetNumberOfObjects () const
 
virtual TObjectGetObject () 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 ()
 
KVBaseoperator= (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)
 
- 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 TObjectClone (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
 
TNamedoperator= (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 
virtual TObjectFindObject (const TObject *obj) const
 
virtual Option_tGetDrawOption () const
 
virtual const char * GetIconName () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 
virtual Option_tGetOption () 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)
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (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
 

Private Attributes

std::map< int, KVCalibratedSignal * > fSignalMap
 
KVList fSignals
 to cleanup signals on delete More...
 

Additional Inherited Members

- Public Types inherited from KVBase
enum  EKaliVedaBits { kIsKaliVedaObject = BIT(23) }
 
- Public Types inherited from TObject
enum  EDeprecatedStatusBits
 
enum  EStatusBits
 
- 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_tFindFile (const Char_t *search, TString &wfil)
 
static const Char_tGetBINDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetDATABASEFilePath ()
 
static const Char_tGetDATADIRFilePath (const Char_t *namefile="")
 
static Bool_t GetDataSetEnv (const Char_t *dataset, const Char_t *type, Bool_t defval)
 
static const Char_tGetDataSetEnv (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_tGetETCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetExampleFilePath (const Char_t *library, const Char_t *namefile)
 Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...
 
static const Char_tGetINCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetKVBuildDate ()
 Returns KaliVeda build date. More...
 
static const Char_tGetKVBuildDir ()
 Returns top-level directory used for build. More...
 
static const Char_tGetKVBuildTime ()
 Returns KaliVeda build time. More...
 
static const Char_tGetKVBuildType ()
 Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...
 
static const Char_tGetKVBuildUser ()
 Returns username of person who performed build. More...
 
static const Char_tGetKVSourceDir ()
 Returns top-level directory of source tree used for build. More...
 
static const Char_tGetKVVersion ()
 Returns KaliVeda version string. More...
 
static const Char_tGetLIBDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetListOfPlugins (const Char_t *base)
 
static const Char_tGetListOfPluginURIs (const Char_t *base)
 
static const Char_tGetPluginURI (const Char_t *base, const Char_t *plugin)
 
static void GetTempFileName (TString &base)
 
static const Char_tGetTEMPLATEDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetWORKDIRFilePath (const Char_t *namefile="")
 
static const Char_tgitBranch ()
 Returns git branch of sources. More...
 
static const Char_tgitCommit ()
 Returns last git commit of sources. More...
 
static void InitEnvironment ()
 
static bool is_gnuinstall ()
 
static Bool_t IsThisAPlugin (const TString &uri, TString &base)
 
static TPluginHandlerLoadPlugin (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_tWorkingDirectory ()
 
- 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)
 
- Public Attributes inherited from TObject
 kBitMask
 
 kCanDelete
 
 kCannotPick
 
 kHasUUID
 
 kInconsistent
 
 kInvalidObject
 
 kIsOnHeap
 
 kIsReferenced
 
 kMustCleanup
 
 kNoContextMenu
 
 kNotDeleted
 
 kObjInCanvas
 
 kOverwrite
 
 kSingleKey
 
 kWriteDelete
 
 kZombie
 
- Protected Member Functions inherited from KVCalibratedSignal
 KVCalibratedSignal (KVDetectorSignal *input, const KVString &output)
 
 KVCalibratedSignal (KVDetectorSignal *input, KVCalibrator *calib)
 
- Protected Member Functions inherited from KVDetectorSignal
void set_value (double x)
 
- 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 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
 

#include <KVZDependentCalibratedSignal.h>

Inheritance diagram for KVZDependentCalibratedSignal:
Inheritance graph
[legend]

Constructor & Destructor Documentation

◆ KVZDependentCalibratedSignal() [1/2]

KVZDependentCalibratedSignal::KVZDependentCalibratedSignal ( )
inline

Definition at line 38 of file KVZDependentCalibratedSignal.h.

◆ KVZDependentCalibratedSignal() [2/2]

KVZDependentCalibratedSignal::KVZDependentCalibratedSignal ( KVDetectorSignal input,
const KVString output 
)
inline

Definition at line 39 of file KVZDependentCalibratedSignal.h.

◆ ~KVZDependentCalibratedSignal()

virtual KVZDependentCalibratedSignal::~KVZDependentCalibratedSignal ( )
inlinevirtual

Definition at line 42 of file KVZDependentCalibratedSignal.h.

Member Function Documentation

◆ AddSignal()

void KVZDependentCalibratedSignal::AddSignal ( KVCalibratedSignal sig,
const KVNumberList zrange 
)

Add signal to be used for all values of Z in the number list range.

Definition at line 12 of file KVZDependentCalibratedSignal.cpp.

◆ GetInverseValue()

Double_t KVZDependentCalibratedSignal::GetInverseValue ( Double_t  out_val,
const TString in_sig,
const KVNameValueList params = "" 
) const
inlinevirtual

Returns the value of the input signal "in_sig" for a given value of this signal, using the inverse calibration function.

Note that "in_sig" may not be the name/type of the direct input signal for this signal, in which case the chain of signals/calibrators is followed back to the required signal.

In case a problem occurs with the calculation, InversionFailure() will return kTRUE.

Any additional parameters required by the calibration can be passed as a comma-separated list of 'parameter=value' pairs

Reimplemented from KVCalibratedSignal.

Definition at line 51 of file KVZDependentCalibratedSignal.h.

◆ GetSignal()

KVCalibratedSignal* KVZDependentCalibratedSignal::GetSignal ( const KVNameValueList params) const
inline

Based on the value of the parameter "Z=..." (which must be present) find the right calibrated signal

Error("GetSignal", "No calibration for Z=%d for detector %s", params.GetIntValue("Z"), GetDetector()->GetName());

Definition at line 57 of file KVZDependentCalibratedSignal.h.

◆ GetValue()

Double_t KVZDependentCalibratedSignal::GetValue ( const KVNameValueList params = "") const
inlinevirtual

Returns the value of the calibrated signal using the current value of the input signal* and the current parameters of the calibration

Any additional parameters required by the calibration can be passed as a comma-separated list of parameter=value pairs

In case a problem occurs with the calculation [in case of an inverted calibration function], InversionFailure() will return kTRUE.

*if a parameter INPUT is given, its value is used instead of the input signal.

Reimplemented from KVCalibratedSignal.

Definition at line 46 of file KVZDependentCalibratedSignal.h.

◆ GetValueNeedsExtraParameters()

Bool_t KVZDependentCalibratedSignal::GetValueNeedsExtraParameters ( ) const
inlinevirtual

Reimplemented from KVDetectorSignal.

Definition at line 83 of file KVZDependentCalibratedSignal.h.

◆ IsAvailableFor()

Bool_t KVZDependentCalibratedSignal::IsAvailableFor ( const KVNameValueList params) const
inlinevirtual

Returns true if a calibration is defined for the "Z=..." parameter value in the list

Reimplemented from KVCalibratedSignal.

Definition at line 73 of file KVZDependentCalibratedSignal.h.

Member Data Documentation

◆ fSignalMap

std::map<int, KVCalibratedSignal*> KVZDependentCalibratedSignal::fSignalMap
mutableprivate

Definition at line 34 of file KVZDependentCalibratedSignal.h.

◆ fSignals

KVList KVZDependentCalibratedSignal::fSignals
private

to cleanup signals on delete

Definition at line 35 of file KVZDependentCalibratedSignal.h.


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