Class for a linear sorting.

   This class returns an index determined via a linear interpolation between
 two values Xmin and Xmax. The following methods are provided by this class:
      virtual Int_t GetNumCase(Double_t x)   Gives an index corresponding to
                                             the value of x. nb_cells being
                                             the total number of indexes, the
                                             returned value is
 
                                                       (x-xmin)*nb_cells
                                             1+(Int_t)-------------------
                                                          xmax-xmin
 
                                             if x<xmin it returns 1
                                             if x>xmax it returns nb_cells
 
      virtual Int_t GetNumCase(void *,...)   return -1,not to use.
 
 BEWARE! : the index value ranges between 1 and nb_cells.
 
  The Xmin and Xmax values can be adjusted with the methods
      virtual void SetXmin(Double_t x)
      virtual void SetXmax(Double_t x)
 
  The name of the sorting variable can be set withe the method
      virtual void SetNomVar(Char_t *s)
 
 The number of indexes can be set with the method
      virtual void SetNbCases(Int_t n)
 
  Setting the number of indexes, the name of the sorting variable or the Xmin
 or Xmax values automatically generates the names for each index.
 
  In a treatment program, this can be used to set histogram titles and to
 manage efficiently arrays of histograms. Here is an example where the sorting
 variable is Ekin (calculated using KVEkin class).
== Example ==================================================================================================
 ...
 KVEkin Sekin;
 Sekin.Init();
 KVZmax Zmax;
 Zmax.Init();
 ...
 KVTrieurLin sortEkin;
 sortEkin.SetNbCases(10);       // 10 indexes
 sortEkin.SetNomVar("E_{kin}"); // name of the sorting variable
 sortEkin.SetXmin(0.);          // minimum value for Ekin
 sortEkin.SetXmax(800.);        // maximum value for Ekin
 ...
 TList *lekin=new TList();      // list to store histograms
 for(Int_t i=0;i<sortEkin.GetNbCases();i++)
  {
  TString sname("histo"); // TString for the histogram name
  sname+=i;
  TString stitle("Z_{max} for "); // TString for the histogram title
  stitle+=sortEkin.GetNomCase(i+1);
  TH1F *h1=new TH1F(sname.Data(),stitle.Data(),100,0.5,100.5);
  lekin->Add(h1); // Add the histogram to the list
  }
 ...
 ...
 Sekin.Reset();
 Zmax.Reset();
 KVINDRAReconNuc *part = 0;
 while( (part = GetEvent()->GetNextParticle("ok")) ){//loop over particles with correct codes
  Sekin.Fill(part);
  Zmax.Fill(part);
 }
 Int_t index=sortEkin(Sekin());       // Determine the index value according to Sekin()
 TH1F *h1=(TH1F *)lekin->At(index-1); // retrieve the histogram in the list
 h1->Fill(Zmax());                    // fill it!
 ...

Definition at line 84 of file KVTrieurLin.h.

Public Member Functions
	KVTrieurLin (Char_t *nom)

	KVTrieurLin (const KVTrieurLin &a)

	KVTrieurLin (Int_t nbcases, Char_t *nom)

	KVTrieurLin (void)

virtual	~ KVTrieurLin (void)

virtual void	Copy (TObject &obj) const
	Make a copy of this object. More...

virtual const Char_t *	GetNomVar (void)

virtual Int_t	GetNumCase (Double_t x)

virtual Int_t	GetNumCase (void *argus ...)

virtual Double_t	GetXmax (void)

virtual Double_t	GetXmin (void)

KVTrieurLin &	operator= (const KVTrieurLin &a)

virtual void	SetNbCases (Int_t n)

virtual void	SetNomVar (Char_t *x)

virtual void	SetXmax (Double_t x)

virtual void	SetXmin (Double_t x)

Public Member Functions inherited from KVTrieur
	KVTrieur (Char_t *nom)

	KVTrieur (const KVTrieur &a)

	KVTrieur (Int_t nbcases, Char_t *nom)

	KVTrieur (void)

virtual	~ KVTrieur (void)

virtual Int_t	GetNbCases (void)
	ajuste le nombre de cases. More...

virtual const Char_t *	GetNomCase (Int_t i)

virtual Int_t	GetNumCase (void *,...)=0
	Retourne le numero de la case correspondant a x. More...

KVTrieur &	operator= (const KVTrieur &a)

virtual void	SetNomCase (Int_t i, Char_t *s)
	Retourne le nom d'une case. More...

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...

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)

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

Public Attributes
Char_t	nom_var [80]

Double_t	xmax

Double_t	xmin

Public Attributes inherited from KVTrieur
Int_t	nb_cases
	Champs publics: More...

TClonesArray *	noms_cases

Public Attributes inherited from TObject
	kBitMask

	kCanDelete

	kCannotPick

	kHasUUID

	kInconsistent

	kInvalidObject

	kIsOnHeap

	kIsReferenced

	kMustCleanup

	kNoContextMenu

	kNotDeleted

	kObjInCanvas

	kOverwrite

	kSingleKey

	kWriteDelete

	kZombie

Static Public Attributes
static Int_t	nb = 0
	Champs Statiques: More...

static Int_t	nb_crea = 0

static Int_t	nb_dest = 0

Static Public Attributes inherited from KVTrieur
static Int_t	nb = 0
	Champs Statiques: More...

static Int_t	nb_crea = 0

static Int_t	nb_dest = 0

Protected Member Functions
void	initKVTrieurLin (void)
	Methodes. More...

void	SetNomsCases (void)

Protected Member Functions inherited from KVTrieur
void	initKVTrieur (void)
	Methodes. More...

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

void	MakeZombie ()

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_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 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 <KVTrieurLin.h>

Inheritance diagram for KVTrieurLin:

[legend]

Constructor & Destructor Documentation

◆ KVTrieurLin() [1/4]

KVTrieurLin::KVTrieurLin ( void )

Createur par default

Definition at line 74 of file KVTrieurLin.cpp.

◆ KVTrieurLin() [2/4]

KVTrieurLin::KVTrieurLin ( Char_t * nom )

Constructeur avec un nom

Definition at line 97 of file KVTrieurLin.cpp.

◆ KVTrieurLin() [3/4]

KVTrieurLin::KVTrieurLin	(	Int_t	nbcases,
		Char_t *	nom
	)

Constructeur avec un nombre de cases et un nom

Definition at line 117 of file KVTrieurLin.cpp.

◆ KVTrieurLin() [4/4]

KVTrieurLin::KVTrieurLin ( const KVTrieurLin & a )

Contructeur par copie

Definition at line 135 of file KVTrieurLin.cpp.

◆ ~ KVTrieurLin()

virtual KVTrieurLin::~ KVTrieurLin ( void )

virtual

Member Function Documentation

◆ Copy()

void KVTrieurLin::Copy ( TObject & obj ) const

virtual

Make a copy of this object.

Reimplemented from KVTrieur.

Definition at line 175 of file KVTrieurLin.cpp.

◆ GetNomVar()

const Char_t * KVTrieurLin::GetNomVar ( void )

virtual

On retourne la vaelur de xmin

Definition at line 345 of file KVTrieurLin.cpp.

◆ GetNumCase() [1/2]

Int_t KVTrieurLin::GetNumCase ( Double_t x )

virtual

retourne le numero de la case correspondante.

On retourne le numero de case

Implements KVTrieur.

Definition at line 245 of file KVTrieurLin.cpp.

◆ GetNumCase() [2/2]

Int_t KVTrieurLin::GetNumCase ( void * argus ... )

virtual

Definition at line 232 of file KVTrieurLin.cpp.

◆ GetXmax()

Double_t KVTrieurLin::GetXmax ( void )

virtual

On retourne la vaelur de xmin

Definition at line 316 of file KVTrieurLin.cpp.

◆ GetXmin()

Double_t KVTrieurLin::GetXmin ( void )

virtual

On retourne la vaelur de xmin

Definition at line 287 of file KVTrieurLin.cpp.

◆ initKVTrieurLin()

void KVTrieurLin::initKVTrieurLin ( void )

protected

Methodes.

Initialisation des champs de KVTrieurLin Cette methode privee n'est appelee par les createurs

Definition at line 21 of file KVTrieurLin.cpp.

◆ operator=()

KVTrieurLin & KVTrieurLin::operator= ( const KVTrieurLin & a )

Operateur =

Definition at line 206 of file KVTrieurLin.cpp.

◆ SetNbCases()

void KVTrieurLin::SetNbCases ( Int_t n )

virtual

retourne le numero de la case correspondante.

On ajuste le nombre de cases

Reimplemented from KVTrieur.

Definition at line 359 of file KVTrieurLin.cpp.

◆ SetNomsCases()

void KVTrieurLin::SetNomsCases ( void )

protected

On affecte les noms aux cases

Definition at line 42 of file KVTrieurLin.cpp.

◆ SetNomVar()

void KVTrieurLin::SetNomVar ( Char_t * x )

virtual

On met la valeur de Xmin

Definition at line 330 of file KVTrieurLin.cpp.

◆ SetXmax()

void KVTrieurLin::SetXmax ( Double_t x )

virtual

On met la valeur de Xmin

Definition at line 301 of file KVTrieurLin.cpp.

◆ SetXmin()

void KVTrieurLin::SetXmin ( Double_t x )

virtual

On met la valeur de Xmin

Definition at line 272 of file KVTrieurLin.cpp.

Member Data Documentation

◆ nb

Int_t KVTrieurLin::nb = 0

static

Champs Statiques:

Definition at line 87 of file KVTrieurLin.h.

◆ nb_crea

Int_t KVTrieurLin::nb_crea = 0

static

Definition at line 88 of file KVTrieurLin.h.

◆ nb_dest

Int_t KVTrieurLin::nb_dest = 0

static

Definition at line 89 of file KVTrieurLin.h.

◆ nom_var

Char_t KVTrieurLin::nom_var[80]

Definition at line 93 of file KVTrieurLin.h.

◆ xmax

Double_t KVTrieurLin::xmax

Definition at line 92 of file KVTrieurLin.h.

◆ xmin

Double_t KVTrieurLin::xmin

Definition at line 91 of file KVTrieurLin.h.

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

kaliveda.doxygen/KVMultiDet/trieur/KVTrieurLin.h
kaliveda.doxygen/KVMultiDet/trieur/KVTrieurLin.cpp

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVTrieurLin() [1/4]

◆ KVTrieurLin() [2/4]

◆ KVTrieurLin() [3/4]

◆ KVTrieurLin() [4/4]

◆ ~ KVTrieurLin()

Member Function Documentation

◆ Copy()

◆ GetNomVar()

◆ GetNumCase() [1/2]

◆ GetNumCase() [2/2]

◆ GetXmax()

◆ GetXmin()

◆ initKVTrieurLin()

◆ operator=()

◆ SetNbCases()

◆ SetNomsCases()

◆ SetNomVar()

◆ SetXmax()

◆ SetXmin()

Member Data Documentation

◆ nb

◆ nb_crea

◆ nb_dest

◆ nom_var

◆ xmax

◆ xmin