An algorithm to unfold distributions from detector to truth level.
TUnfold is used to decompose a measurement y into several sources x, given the measurement uncertainties and a matrix of migrations A. The method can be applied to a large number of problems, where the measured distribution y is a linear superposition of several Monte Carlo shapes. Beyond such a simple template fit, TUnfold has an adjustable regularisation term and also supports an optional constraint on the total number of events.
For most applications, it is better to use the derived class TUnfoldDensity instead of TUnfold. TUnfoldDensity adds various features to TUnfold, such as: background subtraction, propagation of systematic uncertainties, complex multidimensional arrangements of the bins. For innocent users, the most notable improvement of TUnfoldDensity over TUnfold are the getter functions. For TUnfold, histograms have to be booked by the user and the getter functions fill the histogram bins. TUnfoldDensity simply returns a new, already filled histogram.
If you use this software, please consider the following citation
S.Schmitt, JINST 7 (2012) T10003 [arXiv:1205.6201]
Detailed documentation and updates are available on http://www.desy.de/~sschmitt
Brief recipy to use TUnfold:
Basic formulae:
χ2A=(Ax-y)TVyy-1(Ax-y)
χ2L=(x-f*x0)TLTL(x-f*x0)
χ2unf=χ2A+τ2χ2L+λΣi(Ax-y)i
x:result, A:probabilities, y:data, Vyy:data covariance, f:bias scale, x0:bias, L:regularisation conditions, τ:regularisation strength, λ:Lagrangian multiplier
Without area constraint, λ is set to zero, and χ2unf is minimized to determine x. With area constraint, both x and λ are determined.
Public Types | |
| enum | { kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) } |
| enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
| enum | EConstraint { kEConstraintNone =0 , kEConstraintArea =1 } |
| type of extra constraint More... | |
| enum | EDeprecatedStatusBits { kObjInCanvas = (1ULL << (3)) } |
| enum | EHistMap { kHistMapOutputHoriz = 0 , kHistMapOutputVert = 1 } |
| arrangement of axes for the response matrix (TH2 histogram) More... | |
| enum | ERegMode { kRegModeNone = 0 , kRegModeSize = 1 , kRegModeDerivative = 2 , kRegModeCurvature = 3 , kRegModeMixed = 4 } |
| choice of regularisation scheme More... | |
| enum | EStatusBits { kCanDelete = (1ULL << (0)) , kMustCleanup = (1ULL << (3)) , kIsReferenced = (1ULL << (4)) , kHasUUID = (1ULL << (5)) , kCannotPick = (1ULL << (6)) , kNoContextMenu = (1ULL << (8)) , kInvalidObject = (1ULL << (13)) } |
Public Member Functions | |
| TUnfold (const TH2 *hist_A, EHistMap histmap, ERegMode regmode=kRegModeSize, EConstraint constraint=kEConstraintArea) | |
| Set up response matrix and regularisation scheme. | |
| TUnfold (void) | |
| only for use by root streamer or derived classes | |
| ~TUnfold (void) override | |
| void | AbstractMethod (const char *method) const |
| Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it. | |
| virtual void | AppendPad (Option_t *option="") |
| Append graphics object to current pad. | |
| virtual void | Browse (TBrowser *b) |
| Browse object. May be overridden for another default action. | |
| ULong_t | CheckedHash () |
| Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. | |
| virtual const char * | ClassName () const |
| Returns name of class to which the object belongs. | |
| virtual void | Clear (Option_t *="") |
| virtual TObject * | Clone (const char *newname="") const |
| Make a clone of an object using the Streamer facility. | |
| virtual Int_t | Compare (const TObject *obj) const |
| Compare abstract method. | |
| virtual void | Copy (TObject &object) const |
| Copy this to obj. | |
| virtual void | Delete (Option_t *option="") |
| Delete this object. | |
| virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
| Computes distance from point (px,py) to the object. | |
| virtual Double_t | DoUnfold (Double_t tau) |
| perform the unfolding for a given regularisation parameter tau | |
| Double_t | DoUnfold (Double_t tau, const TH1 *hist_y, Double_t scaleBias=0.0) |
| perform the unfolding for a given input and regularisation | |
| virtual void | Draw (Option_t *option="") |
| Default Draw method for all objects. | |
| virtual void | DrawClass () const |
| Draw class inheritance tree of the class to which this object belongs. | |
| virtual TObject * | DrawClone (Option_t *option="") const |
| Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1). | |
| virtual void | Dump () const |
| Dump contents of object on stdout. | |
| virtual void | Error (const char *method, const char *msgfmt,...) const |
| Issue error message. | |
| virtual void | Execute (const char *method, const char *params, Int_t *error=nullptr) |
| Execute method on this object with the given parameter string, e.g. | |
| virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr) |
| Execute method on this object with parameters stored in the TObjArray. | |
| virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
| Execute action corresponding to an event at (px,py). | |
| virtual void | Fatal (const char *method, const char *msgfmt,...) const |
| Issue fatal error message. | |
| virtual TObject * | FindObject (const char *name) const |
| Must be redefined in derived classes. | |
| virtual TObject * | FindObject (const TObject *obj) const |
| Must be redefined in derived classes. | |
| void | GetBias (TH1 *bias, const Int_t *binMap=nullptr) const |
| get bias vector including bias scale | |
| Double_t | GetChi2A (void) const |
| get χ2A contribution determined in recent unfolding | |
| Double_t | GetChi2L (void) const |
| get χ2L contribution determined in recent unfolding | |
| double | GetDF (void) const |
| return the effecive number of degrees of freedom See e.g. | |
| virtual Option_t * | GetDrawOption () const |
| Get option used by the graphics system to draw this object. | |
| void | GetDXDY (TH2 *dxdy) const |
| get matrix connecting input and output changes | |
| void | GetEmatrix (TH2 *ematrix, const Int_t *binMap=nullptr) const |
| get output covariance matrix, possibly cumulated over several bins | |
| Double_t | GetEpsMatrix (void) const |
| get numerical accuracy for Eigenvalue analysis when inverting matrices with rank problems | |
| void | GetFoldedOutput (TH1 *folded, const Int_t *binMap=nullptr) const |
| get unfolding result on detector level | |
| virtual const char * | GetIconName () const |
| Returns mime type name of object. | |
| void | GetInput (TH1 *inputData, const Int_t *binMap=nullptr) const |
| Input vector of measurements. | |
| void | GetInputInverseEmatrix (TH2 *ematrix) |
| get inverse of the measurement's covariance matrix | |
| void | GetL (TH2 *l) const |
| get matrix of regularisation conditions | |
| virtual Double_t | GetLcurveX (void) const |
| get value on x-axis of L-curve determined in recent unfolding | |
| virtual Double_t | GetLcurveY (void) const |
| get value on y-axis of L-curve determined in recent unfolding | |
| void | GetLsquared (TH2 *lsquared) const |
| get matrix of regularisation conditions squared | |
| virtual const char * | GetName () const |
| Returns name of object. | |
| Int_t | GetNdf (void) const |
| get number of degrees of freedom determined in recent unfolding | |
| void | GetNormalisationVector (TH1 *s, const Int_t *binMap=nullptr) const |
| histogram of truth bins, determined from suming over the response matrix | |
| Int_t | GetNpar (void) const |
| get number of truth parameters determined in recent unfolding | |
| Int_t | GetNr (void) const |
| get number of regularisation conditions | |
| virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
| Returns string containing info about the object at position (px,py). | |
| virtual Option_t * | GetOption () const |
| void | GetOutput (TH1 *output, const Int_t *binMap=nullptr) const |
| get output distribution, possibly cumulated over several bins | |
| void | GetProbabilityMatrix (TH2 *A, EHistMap histmap) const |
| get matrix of probabilities | |
| Double_t | GetRhoAvg (void) const |
| get average global correlation determined in recent unfolding | |
| Double_t | GetRhoI (TH1 *rhoi, const Int_t *binMap=nullptr, TH2 *invEmat=nullptr) const |
| get global correlation coefficiencts, possibly cumulated over several bins | |
| void | GetRhoIJ (TH2 *rhoij, const Int_t *binMap=nullptr) const |
| get correlation coefficiencts, possibly cumulated over several bins | |
| Double_t | GetRhoMax (void) const |
| get maximum global correlation determined in recent unfolding | |
| TVectorD | GetSqrtEvEmatrix (void) const |
| double | GetSURE (void) const |
| return Stein's unbiased risk estimator See e.g. | |
| Double_t | GetTau (void) const |
| return regularisation parameter | |
| virtual const char * | GetTitle () const |
| Returns title of object. | |
| virtual UInt_t | GetUniqueID () const |
| Return the unique object id. | |
| virtual Bool_t | HandleTimer (TTimer *timer) |
| Execute action in response of a timer timing out. | |
| virtual ULong_t | Hash () const |
| Return hash value for this object. | |
| Bool_t | HasInconsistentHash () const |
| Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. | |
| virtual void | Info (const char *method, const char *msgfmt,...) const |
| Issue info message. | |
| virtual Bool_t | InheritsFrom (const char *classname) const |
| Returns kTRUE if object inherits from class "classname". | |
| virtual Bool_t | InheritsFrom (const TClass *cl) const |
| Returns kTRUE if object inherits from TClass cl. | |
| virtual void | Inspect () const |
| Dump contents of this object in a graphics canvas. | |
| void | InvertBit (UInt_t f) |
| TClass * | IsA () const override |
| Bool_t | IsDestructed () const |
| IsDestructed. | |
| virtual Bool_t | IsEqual (const TObject *obj) const |
| Default equal comparison (objects are equal if they have the same address in memory). | |
| virtual Bool_t | IsFolder () const |
| Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). | |
| Bool_t | IsOnHeap () const |
| virtual Bool_t | IsSortable () const |
| Bool_t | IsZombie () const |
| virtual void | ls (Option_t *option="") const |
| The ls function lists the contents of a class on stdout. | |
| void | MayNotUse (const char *method) const |
| Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). | |
| virtual Bool_t | Notify () |
| This method must be overridden to handle object notification (the base implementation is no-op). | |
| void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
| Use this method to declare a method obsolete. | |
| void | operator delete (void *, size_t) |
| Operator delete for sized deallocation. | |
| void | operator delete (void *ptr) |
| Operator delete. | |
| void | operator delete (void *ptr, void *vp) |
| Only called by placement new when throwing an exception. | |
| void | operator delete[] (void *, size_t) |
| Operator delete [] for sized deallocation. | |
| void | operator delete[] (void *ptr) |
| Operator delete []. | |
| void | operator delete[] (void *ptr, void *vp) |
| Only called by placement new[] when throwing an exception. | |
| 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) |
| virtual void | Paint (Option_t *option="") |
| This method must be overridden if a class wants to paint itself. | |
| virtual void | Pop () |
| Pop on object drawn in a pad to the top of the display list. | |
| virtual void | Print (Option_t *option="") const |
| This method must be overridden when a class wants to print itself. | |
| virtual Int_t | Read (const char *name) |
| Read contents of object with specified name from the current directory. | |
| virtual void | RecursiveRemove (TObject *obj) |
| Recursively remove this object from a list. | |
| Int_t | RegularizeBins (int start, int step, int nbin, ERegMode regmode) |
| add regularisation conditions for a group of bins | |
| Int_t | RegularizeBins2D (int start_bin, int step1, int nbin1, int step2, int nbin2, ERegMode regmode) |
| add regularisation conditions for 2d unfolding | |
| Int_t | RegularizeCurvature (int left_bin, int center_bin, int right_bin, Double_t scale_left=1.0, Double_t scale_right=1.0) |
| add a regularisation condition on the curvature of three truth bin | |
| Int_t | RegularizeDerivative (int left_bin, int right_bin, Double_t scale=1.0) |
| add a regularisation condition on the difference of two truth bin | |
| Int_t | RegularizeSize (int bin, Double_t scale=1.0) |
| add a regularisation condition on the magnitude of a truth bin | |
| void | ResetBit (UInt_t f) |
| virtual void | SaveAs (const char *filename="", Option_t *option="") const |
| Save this object in the file specified by filename. | |
| virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
| Save a primitive as a C++ statement(s) on output stream "out". | |
| virtual Int_t | ScanLcurve (Int_t nPoint, Double_t tauMin, Double_t tauMax, TGraph **lCurve, TSpline **logTauX=nullptr, TSpline **logTauY=nullptr, TSpline **logTauCurvature=nullptr) |
| scan the L curve, determine tau and unfold at the final value of tau | |
| virtual Int_t | ScanSURE (Int_t nPoint, Double_t tauMin, Double_t tauMax, TGraph **logTauSURE=nullptr, TGraph **df_chi2A=nullptr, TGraph **lCurve=nullptr) |
| minimize Stein's unbiased risk estimator "SURE" using successive calls to DoUnfold at various tau. | |
| void | SetBias (const TH1 *bias) |
| set bias vector | |
| void | SetBit (UInt_t f) |
| void | SetBit (UInt_t f, Bool_t set) |
| Set or unset the user status bits as specified in f. | |
| void | SetConstraint (EConstraint constraint) |
| set type of area constraint | |
| virtual void | SetDrawOption (Option_t *option="") |
| Set drawing option for object. | |
| void | SetEpsMatrix (Double_t eps) |
| set numerical accuracy for Eigenvalue analysis when inverting matrices with rank problems | |
| virtual Int_t | SetInput (const TH1 *hist_y, Double_t scaleBias=0.0, Double_t oneOverZeroError=0.0, const TH2 *hist_vyy=nullptr, const TH2 *hist_vyy_inv=nullptr) |
| Define input data for subsequent calls to DoUnfold(tau). | |
| virtual void | SetUniqueID (UInt_t uid) |
| Set the unique object id. | |
| void | Streamer (TBuffer &) override |
| Stream an object of class TObject. | |
| void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
| virtual void | SysError (const char *method, const char *msgfmt,...) const |
| Issue system error message. | |
| Bool_t | TestBit (UInt_t f) const |
| Int_t | TestBits (UInt_t f) const |
| virtual void | UseCurrentStyle () |
| Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. | |
| virtual void | Warning (const char *method, const char *msgfmt,...) const |
| Issue warning message. | |
| virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) |
| Write this object to the current directory. | |
| virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const |
| Write this object to the current directory. | |
Static Public Member Functions | |
| static TClass * | Class () |
| static const char * | Class_Name () |
| static constexpr Version_t | Class_Version () |
| static const char * | DeclFileName () |
| static Longptr_t | GetDtorOnly () |
| Return destructor only flag. | |
| static Bool_t | GetObjectStat () |
| Get status of object stat flag. | |
| static const char * | GetTUnfoldVersion (void) |
| return a string describing the TUnfold version | |
| static void | SetDtorOnly (void *obj) |
| Set destructor only flag. | |
| static void | SetObjectStat (Bool_t stat) |
| Turn on/off tracking of objects in the TObjectTable. | |
Protected Types | |
| enum | { kOnlyPrepStep = (1ULL << (3)) } |
Protected Member Functions | |
| void | AddMSparse (TMatrixDSparse *dest, Double_t f, const TMatrixDSparse *src) const |
| add a sparse matrix, scaled by a factor, to another scaled matrix | |
| Bool_t | AddRegularisationCondition (Int_t i0, Double_t f0, Int_t i1=-1, Double_t f1=0., Int_t i2=-1, Double_t f2=0.) |
| add a row of regularisation conditions to the matrix L | |
| Bool_t | AddRegularisationCondition (Int_t nEle, const Int_t *indices, const Double_t *rowData) |
| add a row of regularisation conditions to the matrix L | |
| void | ClearHistogram (TH1 *h, Double_t x=0.) const |
| Initialize bin contents and bin errors for a given histogram. | |
| virtual void | ClearResults (void) |
| reset all results | |
| TMatrixDSparse * | CreateSparseMatrix (Int_t nrow, Int_t ncol, Int_t nele, Int_t *row, Int_t *col, Double_t *data) const |
| create a sparse matrix, given the nonzero elements | |
| virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
| Interface to ErrorHandler (protected). | |
| virtual Double_t | DoUnfold (void) |
| core unfolding algorithm | |
| void | ErrorMatrixToHist (TH2 *ematrix, const TMatrixDSparse *emat, const Int_t *binMap, Bool_t doClear) const |
| add up an error matrix, also respecting the bin mapping | |
| const TMatrixDSparse * | GetAx (void) const |
| vector of folded-back result | |
| Int_t | GetBinFromRow (int ix) const |
| converts matrix row to truth histogram bin number | |
| const TMatrixDSparse * | GetDXDAM (int i) const |
| matrix contributions of the derivative dx/dA | |
| const TMatrixDSparse * | GetDXDAZ (int i) const |
| vector contributions of the derivative dx/dA | |
| const TMatrixDSparse * | GetDXDtauSquared (void) const |
| vector of derivative dx/dtauSquared, using internal bin counting | |
| const TMatrixDSparse * | GetDXDY (void) const |
| matrix of derivatives dx/dy | |
| const TMatrixDSparse * | GetE (void) const |
| matrix E, using internal bin counting | |
| const TMatrixDSparse * | GetEinv (void) const |
| matrix E-1, using internal bin counting | |
| Int_t | GetNx (void) const |
| returns internal number of output (truth) matrix rows | |
| Int_t | GetNy (void) const |
| returns the number of measurement bins | |
| virtual TString | GetOutputBinName (Int_t iBinX) const |
| Get bin name of an outpt bin. | |
| Double_t | GetRhoIFromMatrix (TH1 *rhoi, const TMatrixDSparse *eOrig, const Int_t *binMap, TH2 *invEmat) const |
| Int_t | GetRowFromBin (int ix) const |
| converts truth histogram bin number to matrix row | |
| const TMatrixDSparse * | GetVxx (void) const |
| covariance matrix of the result | |
| const TMatrixDSparse * | GetVxxInv (void) const |
| inverse of covariance matrix of the result | |
| const TMatrixDSparse * | GetVyyInv (void) const |
| inverse of covariance matrix of the data y | |
| const TMatrixD * | GetX (void) const |
| vector of the unfolding result | |
| TMatrixDSparse * | InvertMSparseSymmPos (const TMatrixDSparse *A, Int_t *rank) const |
| get the inverse or pseudo-inverse of a positive, sparse matrix | |
| void | MakeZombie () |
| TMatrixDSparse * | MultiplyMSparseM (const TMatrixDSparse *a, const TMatrixD *b) const |
| multiply sparse matrix and a non-sparse matrix | |
| TMatrixDSparse * | MultiplyMSparseMSparse (const TMatrixDSparse *a, const TMatrixDSparse *b) const |
| multiply two sparse matrices | |
| TMatrixDSparse * | MultiplyMSparseMSparseTranspVector (const TMatrixDSparse *m1, const TMatrixDSparse *m2, const TMatrixTBase< Double_t > *v) const |
| calculate a sparse matrix product M1*V*M2T where the diagonal matrix V is given by a vector | |
| TMatrixDSparse * | MultiplyMSparseTranspMSparse (const TMatrixDSparse *a, const TMatrixDSparse *b) const |
| multiply a transposed Sparse matrix with another Sparse matrix | |
Static Protected Member Functions | |
| static void | DeleteMatrix (TMatrixD **m) |
| delete matrix and invalidate pointer | |
| static void | DeleteMatrix (TMatrixDSparse **m) |
| delete sparse matrix and invalidate pointer | |
| static void | SavePrimitiveConstructor (std::ostream &out, TClass *cl, const char *variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE) |
| Save object constructor in the output stream "out". | |
| static void | SavePrimitiveDraw (std::ostream &out, const char *variable_name, Option_t *option=nullptr) |
| Save invocation of primitive Draw() method Skipped if option contains "nodraw" string. | |
| static TString | SavePrimitiveVector (std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0) |
| Save array in the output stream "out" as vector. | |
Protected Attributes | |
| TMatrixDSparse * | fA |
| response matrix A | |
| Double_t | fBiasScale |
| scale factor for the bias | |
| EConstraint | fConstraint |
| type of constraint to use for the unfolding | |
| TArrayI | fHistToX |
| mapping of histogram bins to matrix indices | |
| TMatrixDSparse * | fL |
| regularisation conditions L | |
| ERegMode | fRegMode |
| type of regularisation | |
| TArrayD | fSumOverY |
| truth vector calculated from the non-normalized response matrix | |
| Double_t | fTauSquared |
| regularisation parameter tau squared | |
| TMatrixDSparse * | fVyy |
| covariance matrix Vyy corresponding to y | |
| TMatrixD * | fX0 |
| bias vector x0 | |
| TArrayI | fXToHist |
| mapping of matrix indices to histogram bins | |
| TMatrixD * | fY |
| input (measured) data y | |
Private Member Functions | |
| void | InitTUnfold (void) |
| initialize data menbers, for use in constructors | |
Static Private Member Functions | |
| static void | AddToTObjectTable (TObject *) |
| Private helper function which will dispatch to TObjectTable::AddObj. | |
Private Attributes | |
| TMatrixDSparse * | fAx |
| result x folded back A*x | |
| UInt_t | fBits |
| bit field status word | |
| Double_t | fChi2A |
| chi**2 contribution from (y-Ax)Vyy-1(y-Ax) | |
| TMatrixDSparse * | fDXDAM [2] |
| matrix contribution to the of derivative dx_k/dA_ij | |
| TMatrixDSparse * | fDXDAZ [2] |
| vector contribution to the of derivative dx_k/dA_ij | |
| TMatrixDSparse * | fDXDtauSquared |
| derivative of the result wrt tau squared | |
| TMatrixDSparse * | fDXDY |
| derivative of the result wrt dx/dy | |
| TMatrixDSparse * | fE |
| matrix E | |
| TMatrixDSparse * | fEinv |
| matrix E^(-1) | |
| Double_t | fEpsMatrix |
| machine accuracy used to determine matrix rank after eigenvalue analysis | |
| Int_t | fIgnoredBins |
| number of input bins which are dropped because they have error=nullptr | |
| Double_t | fLXsquared |
| chi**2 contribution from (x-s*x0)TLTL(x-s*x0) | |
| Int_t | fNdf |
| number of degrees of freedom | |
| Double_t | fRhoAvg |
| average global correlation coefficient | |
| Double_t | fRhoMax |
| maximum global correlation coefficient | |
| UInt_t | fUniqueID |
| object unique identifier | |
| TMatrixDSparse * | fVxx |
| covariance matrix Vxx | |
| TMatrixDSparse * | fVxxInv |
| inverse of covariance matrix Vxx-1 | |
| TMatrixDSparse * | fVyyInv |
| inverse of the input covariance matrix Vyy-1 | |
| TMatrixD * | fX |
| unfolding result x | |
Static Private Attributes | |
| static Longptr_t | fgDtorOnly = 0 |
| object for which to call dtor only (i.e. no delete) | |
| static Bool_t | fgObjectStat = kTRUE |
| if true keep track of objects in TObjectTable | |
#include <TUnfold.h>
|
protectedinherited |
|
inherited |
|
inherited |
| enum TUnfold::EConstraint |
|
inherited |
| enum TUnfold::EHistMap |
| enum TUnfold::ERegMode |
choice of regularisation scheme
|
inherited |
| TUnfold::TUnfold | ( | const TH2 * | hist_A, |
| EHistMap | histmap, | ||
| ERegMode | regmode = kRegModeSize, | ||
| EConstraint | constraint = kEConstraintArea ) |
Set up response matrix and regularisation scheme.
| [in] | hist_A | matrix of MC events that describes the migrations |
| [in] | histmap | mapping of the histogram axes |
| [in] | regmode | (default=kRegModeSize) global regularisation mode |
| [in] | constraint | (default=kEConstraintArea) type of constraint |
Treatment of overflow bins in the matrix hist_A
If unsure, do the following:
Definition at line 1699 of file TUnfold.cxx.
| TUnfold::TUnfold | ( | void | ) |
only for use by root streamer or derived classes
Definition at line 238 of file TUnfold.cxx.
|
override |
Definition at line 127 of file TUnfold.cxx.
|
inherited |
Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.
Definition at line 1149 of file TObject.cxx.
|
protected |
add a sparse matrix, scaled by a factor, to another scaled matrix
| [in,out] | dest | destination matrix |
| [in] | f | scaling factor |
| [in] | src | matrix to be added to dest |
a replacement for (*dest) += f * (*src) which suffered from a bug in old root versions
Definition at line 915 of file TUnfold.cxx.
|
protected |
add a row of regularisation conditions to the matrix L
| [in] | i0 | truth histogram bin number |
| [in] | f0 | entry in the matrix L, column i0 |
| [in] | i1 | truth histogram bin number |
| [in] | f1 | entry in the matrix L, column i1 |
| [in] | i2 | truth histogram bin number |
| [in] | f2 | entry in the matrix L, column i2 |
the arguments are used to form one row (k) of the matrix L, where
Lk,i0=f0 and Lk,i1=f1 and Lk,i2=f2
negative indexes i0,i1,i2 are ignored
Definition at line 1917 of file TUnfold.cxx.
|
protected |
add a row of regularisation conditions to the matrix L
| [in] | nEle | number of valid entries in indeces and rowData |
| [in] | indices | column numbers of L to fill |
| [in] | rowData | data to fill into the new row of L |
returns true if a row was added, false otherwise
A new row k is added to the matrix L, its dimension is expanded. The new elements Lki are filled from the array rowData[] where the indices i which are taken from the array indices[].
Definition at line 1954 of file TUnfold.cxx.
|
staticprivateinherited |
Private helper function which will dispatch to TObjectTable::AddObj.
Included here to avoid circular dependency between header files.
Definition at line 195 of file TObject.cxx.
|
virtualinherited |
Append graphics object to current pad.
In case no current pad is set yet, create a default canvas with the name "c1".
Definition at line 204 of file TObject.cxx.
|
virtualinherited |
Browse object. May be overridden for another default action.
Reimplemented in RooPlot, ROOT::Experimental::XRooFit::xRooNode, ROOT::Internal::THnBaseBrowsable, TApplicationRemote, TASImage, TAxis3D, TBaseClass, TBranch, TBranchClones, TBranchElement, TBranchObject, TBranchSTL, TBrowserObject, TCanvas, TChain, TClass, TCollection, TCollectionPropertyBrowsable, TDatabasePDG, TDirectory, TDirectoryFile, TEfficiency, TF1, TFolder, TGenerator, TGeoManager, TGeometry, TGeoNode, TGeoOverlap, TGeoTrack, TGeoVolume, TGraph2D, TGraph, TH1, THbookBranch, THbookFile, THbookKey, THnBase, THStack, TKey, TKeyMapFile, TLeaf, TMacro, TMapFile, TMultiDimFit, TMultiGraph, TNode, TNtuple, TNtupleD, TPad, TPair, TParticleClassPDG, TPrincipal, TRecorder, TRemoteObject, TROOT, TRootIconList, TSPlot, TStyle, TSystemDirectory, TSystemFile, TTask, TTree, TTreePerfStats, and TVirtualBranchBrowsable.
Definition at line 218 of file TObject.cxx.
|
inlineinherited |
Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();
(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.
|
static |
|
static |
|
inlinestaticconstexpr |
|
virtualinherited |
Returns name of class to which the object belongs.
Definition at line 227 of file TObject.cxx.
|
inlinevirtualinherited |
Reimplemented in JetEvent, RooLinkedList, ROOT::TSchemaRule, ROOT::v5::TFormula, TBackCompFitter, TBits, TBranchRef, TBtree, TCanvas, TClonesArray, TCollection, TDictAttributeMap, TDirectory, TEventList, TFitter, TFolder, TFormula, TFumili, TGeoCombiTrans, TGeoGenTrans, TGeoHMatrix, TGeoRotation, TGHtml, TGraph2D, TGTextEdit, TGTextEntry, TGTextView, TGView, THashList, THashTable, TLegend, TLinearFitter, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMap, TMatrixT< Element >, TMatrixT< AReal >, TMatrixT< Double_t >, TMatrixT< Float_t >, TMatrixTBase< Element >, TMatrixTBase< Double_t >, TMatrixTBase< Float_t >, TMatrixTSparse< Element >, TMatrixTSparse< Double_t >, TMatrixTSparse< Float_t >, TMatrixTSym< Element >, TMatrixTSym< Double_t >, TMatrixTSym< Float_t >, TMrbSubevent_Caen, TMultiDimFit, TMVA::MinuitWrapper, TMVA::ResultsClassification, TMVA::ResultsMulticlass, TMVA::ResultsRegression, TNamed, TNotifyLinkBase, TObjArray, TOrdCollection, TPad, TPaveText, TPrincipal, TProcessID, TRefArray, TRefTable, TStreamerInfo, TTask, TUsrHitBuffer, TVectorT< Element >, TVectorT< Double_t >, TVectorT< Float_t >, TViewPubDataMembers, TViewPubFunctions, TVirtualFitter, TVirtualPad, and TVirtualStreamerInfo.
Initialize bin contents and bin errors for a given histogram.
| [out] | h | histogram |
| [in] | x | new histogram content |
all histgram errors are set to zero, all contents are set to x
Definition at line 3680 of file TUnfold.cxx.
|
protectedvirtual |
|
virtualinherited |
Make a clone of an object using the Streamer facility.
If the object derives from TNamed, this function is called by TNamed::Clone. TNamed::Clone uses the optional argument to set a new name to the newly created object.
If the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.
Reimplemented in RooAbsArg, RooAbsBinning, RooAbsCollection, RooAbsStudy, RooCatType, RooCmdArg, RooDataHist, RooDataSet, RooFitResult, RooLinkedList, RooStats::HypoTestResult, RooStats::ModelConfig, RooStudyPackage, RooTemplateProxy< T >, RooTemplateProxy< const RooHistFunc >, RooTemplateProxy< RooAbsCategory >, RooTemplateProxy< RooAbsPdf >, RooTemplateProxy< RooAbsReal >, RooTemplateProxy< RooAbsRealLValue >, RooTemplateProxy< RooMultiCategory >, RooTemplateProxy< RooRealVar >, RooWorkspace, TASImage, TChainIndex, TClass, TCollection, TF1, TFunction, TFunctionTemplate, TH1, TImage, TMethod, TMethodCall, TMinuit, TMVA::MinuitWrapper, TNamed, TStreamerInfo, and TTreeIndex.
Definition at line 243 of file TObject.cxx.
Compare abstract method.
Must be overridden if a class wants to be able to compare itself with other objects. Must return -1 if this is smaller than obj, 0 if objects are equal and 1 if this is larger than obj.
Reimplemented in RooAbsArg, RooDouble, TCollection, TEnvRec, TFileInfo, TGeoBranchArray, TGeoOverlap, TGFSFrameElement, TGLBFrameElement, TNamed, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TStructNode, TStructNodeProperty, and TUrl.
Definition at line 258 of file TObject.cxx.
|
virtualinherited |
Copy this to obj.
Reimplemented in ROOT::v5::TFormula, TArc, TArrow, TAxis3D, TAxis, TBox, TColor, TCrown, TDirectory, TDirectoryFile, TEllipse, TF12, TF1, TF1AbsComposition, TF1Convolution, TF1NormSum, TF2, TF3, TFile, TFolder, TFormula, TFrame, TGTextEdit, TGTextView, TH1, TH1C, TH1D, TH1F, TH1I, TH1L, TH1S, TH2, TH2C, TH2D, TH2F, TH2I, TH2L, TH2Poly, TH2S, TH3, TH3C, TH3D, TH3F, TH3I, TH3L, TH3S, THelix, TLatex, TLegend, TLegendEntry, TLine, TMarker, TMathText, TNamed, TPaletteAxis, TPave, TPaveClass, TPaveLabel, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TStyle, TSystemDirectory, TSystemFile, TText, TWbox, and TXTRU.
Definition at line 159 of file TObject.cxx.
|
protected |
create a sparse matrix, given the nonzero elements
| [in] | nrow | number of rows |
| [in] | ncol | number of columns |
| [in] | nel | number of non-zero elements |
| [in] | row | row indexes of non-zero elements |
| [in] | col | column indexes of non-zero elements |
| [in] | data | non-zero elements data |
return pointer to a new sparse matrix
shortcut to new TMatrixDSparse() followed by SetMatrixArray()
Definition at line 578 of file TUnfold.cxx.
|
inlinestatic |
|
virtualinherited |
Delete this object.
Typically called as a command via the interpreter. Normally use "delete" operator when object has been allocated on the heap.
Reimplemented in RooLinkedList, TAxis, TBtree, TCanvas, TClonesArray, TCollection, TDirectory, TDirectoryFile, TExMap, TFile, TGFrame, TGItemContext, TGTextEdit, THashList, THashTable, TKey, TKeySQL, TKeyXML, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMap, TMVA::Results, TObjArray, TObjectTable, TOrdCollection, TProtoClass, TQCommand, TRefArray, TSystemDirectory, TSystemFile, TThread, TTree, TTreeViewer, TViewPubDataMembers, and TViewPubFunctions.
Definition at line 268 of file TObject.cxx.
|
staticprotected |
delete matrix and invalidate pointer
| [in,out] | m | pointer to a matrix-pointer |
if the matrix pointer os non-zero, thematrix id deleted. The matrox pointer is set to zero.
Definition at line 188 of file TUnfold.cxx.
|
staticprotected |
delete sparse matrix and invalidate pointer
| [in,out] | m | pointer to a matrix-pointer |
if the matrix pointer os non-zero, thematrix id deleted. The matrox pointer is set to zero.
Definition at line 200 of file TUnfold.cxx.
Computes distance from point (px,py) to the object.
This member function must be implemented for each graphics primitive. This default function returns a big number (999999).
Reimplemented in TASImage, TAxis3D, TAxis, TBox, TBRIK, TColorWheel, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFileDrawMap, TGenerator, TGeoBBox, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoEltu, TGeoHalfSpace, TGeoHype, TGeoNode, TGeoOverlap, TGeoParaboloid, TGeoPcon, TGeoPgon, TGeoScaledShape, TGeoShape, TGeoShapeAssembly, TGeoSphere, TGeoTessellated, TGeoTorus, TGeoTrack, TGeoTube, TGeoTubeSeg, TGeoVGShape, TGeoVolume, TGeoXtru, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TH1, THistPainter, THStack, TLine, TMarker3DBox, TMarker, TMultiGraph, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPCON, TPie, TPieSlice, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSPHE, TSpider, TSpline, TStyle, TText, TTreePerfStats, TTUBE, TTUBS, TVirtualHistPainter, and TXTRU.
Definition at line 284 of file TObject.cxx.
|
protectedvirtualinherited |
Interface to ErrorHandler (protected).
Reimplemented in TThread, and TTreeViewer.
Definition at line 1059 of file TObject.cxx.
perform the unfolding for a given regularisation parameter tau
| [in] | tau | regularisation parameter |
this method sets tau and then calls the core unfolding algorithm
Definition at line 2491 of file TUnfold.cxx.
perform the unfolding for a given input and regularisation
| [in] | tau_reg | regularisation parameter |
| [in] | input | input distribution with uncertainties |
| [in] | scaleBias | (default=0.0) scale factor applied to the bias |
This is a shortcut for { SetInput(input,scaleBias); DoUnfold(tau); }
Definition at line 2235 of file TUnfold.cxx.
|
protectedvirtual |
core unfolding algorithm
Definition at line 246 of file TUnfold.cxx.
|
virtualinherited |
Default Draw method for all objects.
Reimplemented in RooAbsData, RooPlot, RooStats::HypoTestInverterPlot, RooStats::SamplingDistPlot, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, ROOT::RGeoPainter, TArrow, TASImage, TBox, TBrowser, TButton, TCanvas, TChain, TClass, TClassTree, TCollection, TColorWheel, TDiamond, TDirectory, TEfficiency, TEllipse, TEveGeoNode, TEveGeoTopNode, TF1, TF2, TF3, TFile, TFITSHDU, TFrame, TGenerator, TGeoBatemanSol, TGeometry, TGeoNode, TGeoOverlap, TGeoPainter, TGeoParallelWorld, TGeoPhysicalNode, TGeoPolygon, TGeoShape, TGeoTrack, TGeoVGShape, TGeoVolume, TGItemContext, TGListTree, TGPicture, TGraph2D, TGraph, TGraphPolar, TGraphPolargram, TGraphStruct, TGraphTime, TH1, THelix, THStack, TLegend, TMarker, TMatrixTBase< Element >, TMatrixTBase< Double_t >, TMatrixTBase< Float_t >, TMultiDimFit, TMultiGraph, TMultiLayerPerceptron, TNode, TNodeDiv, TPad, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TPave, TPaveLabel, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TRatioPlot, TSpider, TSpline, TStructViewer, TStructViewerGUI, TTree, TTreePerfStats, TVectorT< Element >, TVectorT< Double_t >, TVectorT< Float_t >, TVirtualPad, and TWbox.
Definition at line 293 of file TObject.cxx.
|
virtualinherited |
Draw class inheritance tree of the class to which this object belongs.
If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:
Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.
Definition at line 308 of file TObject.cxx.
Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
If pad was not selected - gPad will be used.
Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.
Definition at line 319 of file TObject.cxx.
|
virtualinherited |
Dump contents of object on stdout.
Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed
The following output is the Dump of a TArrow object:
Reimplemented in TClass, TCollection, TGFrame, TGPack, and TSystemFile.
Definition at line 367 of file TObject.cxx.
|
virtualinherited |
Issue error message.
Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.
Reimplemented in TFitResult.
Definition at line 1098 of file TObject.cxx.
|
protected |
add up an error matrix, also respecting the bin mapping
| [in,out] | ematrix | error matrix histogram |
| [in] | emat | error matrix stored with internal mapping (member fXToHist) |
| [in] | binMap | mapping of histogram bins |
| [in] | doClear | if true, ematrix is cleared prior to adding elements of emat to it. |
the array binMap is explained with the method GetOutput(). The matrix emat must have dimension NxN where N=fXToHist.size() The flag doClear may be used to add covariance matrices from several uncertainty sources.
Definition at line 3379 of file TUnfold.cxx.
|
virtualinherited |
Execute method on this object with the given parameter string, e.g.
"3.14,1,\"text\"".
Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.
Definition at line 378 of file TObject.cxx.
|
virtualinherited |
Execute method on this object with parameters stored in the TObjArray.
The TObjArray should contain an argv vector like:
Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.
Definition at line 398 of file TObject.cxx.
Execute action corresponding to an event at (px,py).
This method must be overridden if an object can react to graphics events.
Reimplemented in TASImage, TASPaletteEditor::LimitLine, TAxis3D, TAxis, TBox, TButton, TCanvas, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFrame, TGenerator, TGeoManager, TGeoNode, TGeoOverlap, TGeoShape, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLEventHandler, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGroupButton, TH1, THistPainter, TLine, TLink, TMarker3DBox, TMarker, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSliderBox, TSpider, TSpline, TText, TTreePerfStats, TView3D, TView, TVirtualHistPainter, and TWbox.
Definition at line 415 of file TObject.cxx.
|
virtualinherited |
Issue fatal error message.
Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.
Definition at line 1126 of file TObject.cxx.
|
virtualinherited |
Must be redefined in derived classes.
This function is typically used with TCollections, but can also be used to find an object by name inside this object.
Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.
Definition at line 425 of file TObject.cxx.
Must be redefined in derived classes.
This function is typically used with TCollections, but can also be used to find an object inside this object.
Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.
Definition at line 435 of file TObject.cxx.
|
inlineprotected |
get bias vector including bias scale
| [out] | out | histogram to store the scaled bias vector. The bin contents are overwritten |
| [in] | binMap | (default=nullptr) array for mapping truth bins to histogram bins |
This method returns the bias vector times scaling factor, f*x0
The use of binMap is explained with the documentation of the GetOutput() method
Definition at line 2935 of file TUnfold.cxx.
|
inline |
| Double_t TUnfold::GetChi2L | ( | void | ) | const |
get χ2L contribution determined in recent unfolding
Definition at line 3231 of file TUnfold.cxx.
| double TUnfold::GetDF | ( | void | ) | const |
return the effecive number of degrees of freedom See e.g.
arXiv:1612.09415 and the references therein
Here, DF is calculated using the dependence of the unfolding result x on the data y
This calculation is done assuming a CONSTANT data variance. I.e. the uncertainties reported to TUnfold in "SetInput()" ought to be independent of the measurements. This is NOT true for standard Poisson-distributed data. In practice the impact is expected to be small
Definition at line 3749 of file TUnfold.cxx.
|
virtualinherited |
Get option used by the graphics system to draw this object.
Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.
Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.
Definition at line 445 of file TObject.cxx.
|
staticinherited |
Return destructor only flag.
Definition at line 1196 of file TObject.cxx.
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
| void TUnfold::GetDXDY | ( | TH2 * | dxdy | ) | const |
get matrix connecting input and output changes
get matrix describing gow the result changes with the input data
| [out] | dxdy | two-dimensional histogram to store the matrix connecting the output and input data. The bin contents are overwritten for those bins where dxdy is non-zero. |
Definition at line 3038 of file TUnfold.cxx.
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
get output covariance matrix, possibly cumulated over several bins
| [out] | ematrix | histogram to store the covariance. The bin contents are overwritten. |
| [in] | binMap | (default=nullptr) array for mapping truth bins to histogram bins |
The use of binMap is explained with the documentation of the GetOutput() method
Definition at line 3446 of file TUnfold.cxx.
|
inline |
get unfolding result on detector level
| [out] | out | histogram to store the correlation coefficiencts. The bin contents and errors are overwritten. |
| [in] | binMap | (default=nullptr) array for mapping truth bins to histogram bins |
This method returns the unfolding output folded by the response matrix, i.e. the vector Ax.
The use of binMap is explained with the documentation of the GetOutput() method
Definition at line 2962 of file TUnfold.cxx.
|
virtualinherited |
Returns mime type name of object.
Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.
Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.
Definition at line 472 of file TObject.cxx.
Input vector of measurements.
| [out] | out | histogram to store the measurements. Bin content and bin errors are overwritte. |
| [in] | binMap | (default=nullptr) array for mapping truth bins to histogram bins |
Bins which had an uncertainty of zero in the call to SetInput() maye acquire bin contents or bin errors different from the original settings in SetInput().
The use of binMap is explained with the documentation of the GetOutput() method
Definition at line 3069 of file TUnfold.cxx.
| void TUnfold::GetInputInverseEmatrix | ( | TH2 * | out | ) |
get inverse of the measurement's covariance matrix
| [out] | out | histogram to store the inverted covariance |
Definition at line 3098 of file TUnfold.cxx.
| void TUnfold::GetL | ( | TH2 * | out | ) | const |
get matrix of regularisation conditions
| [out] | out | histogram to store the regularisation conditions. the bincontents are overwritten |
The histogram should have dimension nr (y-axis) times nx (x-axis). nr corresponds to the number of regularisation conditions, it can be obtained using the method GetNr(). nx corresponds to the number of histogram bins in the response matrix along the truth axis.
Definition at line 3191 of file TUnfold.cxx.
|
virtual |
get value on x-axis of L-curve determined in recent unfolding
x=log10(GetChi2A())
Definition at line 3251 of file TUnfold.cxx.
|
virtual |
get value on y-axis of L-curve determined in recent unfolding
y=log10(GetChi2L())
Definition at line 3260 of file TUnfold.cxx.
| void TUnfold::GetLsquared | ( | TH2 * | out | ) | const |
get matrix of regularisation conditions squared
| [out] | out | histogram to store the squared matrix of regularisation conditions. the bin contents are overwritten |
This returns the square matrix LTL as a histogram
The histogram should have dimension nx times nx, where nx corresponds to the number of histogram bins in the response matrix along the truth axis.
Definition at line 3151 of file TUnfold.cxx.
|
virtualinherited |
Returns name of object.
This default method returns the class name. Classes that give objects a name should override this method.
Reimplemented in RooAbsCollection, RooCatType, RooLinkedList, TArchiveMember, TCollection, TEnvRec, TEveGeoNode, TGaxis, TGeoDecayChannel, TGeoShape, TGeoVGShape, TGLEmbeddedViewer, TGLPShapeObj, TGLSAViewer, TGMenuEntry, TGMenuTitle, TGPicture, TGWindow, TIconBoxThumb, TMapFile, TMVA::DataSetInfo, TMVA::FitterBase, TMVA::MethodBase, TMVA::OptionBase, TMVA::PDF, TMVA::Reader, TMVA::VariableTransformBase, TNamed, TObjString, TPad, TPair, TParameter< AParamType >, TParameter< Long64_t >, TParticle, TPave, TPolyMarker3D, TPrimary, TQCommand, TQConnection, TQSlot, TRealData, TSQLClassColumnInfo, TSQLClassInfo, TSQLColumnData, TStatistic, TStructNode, TTreePerfStats, TTVRecord, TTVSession, TVirtualGeoTrack, TVirtualPad, and TXMLAttr.
Definition at line 462 of file TObject.cxx.
|
inline |
histogram of truth bins, determined from suming over the response matrix
| [out] | out | histogram to store the truth bins. The bin contents are overwritten |
| [in] | binMap | (default=nullptr) array for mapping truth bins to histogram bins |
This vector is also used to initialize the bias x0. However, the bias vector may be changed using the SetBias() method.
The use of binMap is explained with the documentation of the GetOutput() method
Definition at line 2910 of file TUnfold.cxx.
| Int_t TUnfold::GetNpar | ( | void | ) | const |
get number of truth parameters determined in recent unfolding
empty bins of the response matrix or bins which can not be unfolded due to rank deficits are not counted
Definition at line 3242 of file TUnfold.cxx.
| Int_t TUnfold::GetNr | ( | void | ) | const |
get number of regularisation conditions
Ths returns the number of regularisation conditions, useful for booking a histogram for a subsequent call of GetL().
Definition at line 3176 of file TUnfold.cxx.
|
inlineprotected |
|
inlineprotected |
Returns string containing info about the object at position (px,py).
This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).
Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.
Definition at line 491 of file TObject.cxx.
|
staticinherited |
Get status of object stat flag.
Definition at line 1181 of file TObject.cxx.
|
inlinevirtualinherited |
Reimplemented in TArrow, TAxis3D, TFile, TGaxis, TGeoVolume, TH1, THelix, TLegendEntry, TMapFile, TNode, TPave, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPSocket, TSelector, TSocket, and TUDPSocket.
get output distribution, possibly cumulated over several bins
| [out] | output | existing output histogram. content and errors will be updated. |
| [in] | binMap | (default=nullptr) array for mapping truth bins to histogram bins |
If nonzero, the array binMap must have dimension n+2, where n corresponds to the number of bins on the truth axis of the response matrix (the histogram specified with the TUnfold constructor). The indexes of binMap correspond to the truth bins (including underflow and overflow) of the response matrix. The element binMap[i] specifies the histogram number in output where the corresponding truth bin will be stored. It is possible to specify the same output bin number for multiple indexes, in which case these bins are added. Set binMap[i]=-1 to ignore an unfolded truth bin. The uncertainties are calculated from the corresponding parts of the covariance matrix, properly taking care of added truth bins.
If the pointer binMap is zero, the bins are mapped one-to-one. Truth bin zero (underflow) is stored in the output underflow, truth bin 1 is stored in bin number 1, etc.
Definition at line 3289 of file TUnfold.cxx.
Get bin name of an outpt bin.
| [in] | iBinX | bin number |
Return value: name of the bin
For TUnfold and TUnfoldSys, this function simply returns the bin number as a string. This function really only makes sense in the context of TUnfoldDensity, where binnig schemes are implemented using the class TUnfoldBinning, and non-trivial bin names are returned.
Reimplemented in TUnfoldDensity.
Definition at line 1667 of file TUnfold.cxx.
get matrix of probabilities
| [out] | A | two-dimensional histogram to store the probabilities (normalized response matrix). The bin contents are overwritten for those bins where A is nonzero |
| [in] | histmap | specify axis along which the truth bins are oriented |
Definition at line 3010 of file TUnfold.cxx.
|
inline |
| Double_t TUnfold::GetRhoI | ( | TH1 * | rhoi, |
| const Int_t * | binMap = nullptr, | ||
| TH2 * | invEmat = nullptr ) const |
get global correlation coefficiencts, possibly cumulated over several bins
| [out] | rhoi | histogram to store the global correlation coefficients. The bin contents are overwritten. |
| [in] | binMap | (default=nullptr) array for mapping truth bins to histogram bins |
| [out] | invEmat | (default=nullptr) histogram to store the inverted covariance matrix |
for a given bin, the global correlation coefficient is defined as
ρi=sqrt(1-1/(Vii*V-1ii))
such that the calculation of global correlation coefficients possibly involves the inversion of a covariance matrix.
return value: maximum global correlation coefficient
The use of binMap is explained with the documentation of the GetOutput() method
Definition at line 3504 of file TUnfold.cxx.
|
protected |
Definition at line 3553 of file TUnfold.cxx.
get correlation coefficiencts, possibly cumulated over several bins
| [out] | rhoij | histogram to store the correlation coefficiencts. The bin contents are overwritten. |
| [in] | binMap | (default=nullptr) array for mapping truth bins to histogram bins |
The use of binMap is explained with the documentation of the GetOutput() method
Definition at line 3461 of file TUnfold.cxx.
|
inline |
| TVectorD TUnfold::GetSqrtEvEmatrix | ( | void | ) | const |
Definition at line 2509 of file TUnfold.cxx.
| double TUnfold::GetSURE | ( | void | ) | const |
return Stein's unbiased risk estimator See e.g.
arXiv:1612.09415
A minimum in the SURE variable is a good choice of regularisation strength
NOTE: the calculation of SURE depends on the calculation of DF. See the method GetDF() for caveats with Poisson-distributed data.
Definition at line 3732 of file TUnfold.cxx.
| Double_t TUnfold::GetTau | ( | void | ) | const |
return regularisation parameter
Definition at line 3223 of file TUnfold.cxx.
|
virtualinherited |
Returns title of object.
This default method returns the class title (i.e. description). Classes that give objects a title should override this method.
Reimplemented in Axis2, TASImage, TAxis, TBaseClass, TClassMenuItem, TEveGeoNode, TEvePointSet, TGaxis, TGGroupFrame, TGLabel, TGLVEntry, TGTextButton, TGTextEntry, TGTextLBEntry, TKey, TMapFile, TNamed, TPad, TPair, TParallelCoordSelect, TParticle, TPaveLabel, TPrimary, TQCommand, TRootIconList, and TVirtualPad.
Definition at line 507 of file TObject.cxx.
|
static |
return a string describing the TUnfold version
The version is reported in the form Vmajor.minor Changes of the minor version number typically correspond to bug-fixes. Changes of the major version may result in adding or removing data attributes, such that the streamer methods are not compatible between different major versions.
Definition at line 3717 of file TUnfold.cxx.
|
virtualinherited |
Return the unique object id.
Definition at line 480 of file TObject.cxx.
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
Execute action in response of a timer timing out.
This method must be overridden if an object has to react to timers.
Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.
Definition at line 516 of file TObject.cxx.
|
virtualinherited |
Return hash value for this object.
Note: If this routine is overloaded in a derived class, this derived class should also add
Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like
Reimplemented in RooLinkedList, TASImagePlugin, TASPluginGS, TCollection, TEnvRec, TGObject, TGPicture, TIconBoxThumb, TImagePlugin, TNamed, TObjString, TPad, TPair, TParameter< AParamType >, TParameter< Long64_t >, TPave, and TStatistic.
Definition at line 539 of file TObject.cxx.
|
inlineinherited |
Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
missing call to RecursiveRemove in destructor).
Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)
|
virtualinherited |
Issue info message.
Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.
Definition at line 1072 of file TObject.cxx.
|
virtualinherited |
Returns kTRUE if object inherits from class "classname".
Reimplemented in TClass.
Definition at line 549 of file TObject.cxx.
Returns kTRUE if object inherits from TClass cl.
Reimplemented in TClass.
Definition at line 557 of file TObject.cxx.
|
private |
initialize data menbers, for use in constructors
Definition at line 144 of file TUnfold.cxx.
|
virtualinherited |
Dump contents of this object in a graphics canvas.
Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.
The following picture is the Inspect of a histogram object:
Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.
Definition at line 570 of file TObject.cxx.
|
protected |
get the inverse or pseudo-inverse of a positive, sparse matrix
| [in] | A | the sparse matrix to be inverted, has to be positive |
| [in,out] | rankPtr | if zero, suppress calculation of pseudo-inverse otherwise the rank of the matrix is returned in *rankPtr |
return value: 0 or a new sparse matrix
the matrix inversion is optimized in performance for the case where a large submatrix of A is diagonal
Definition at line 992 of file TUnfold.cxx.
|
inlineoverridevirtual |
Reimplemented from TObject.
Reimplemented in TUnfoldDensity, and TUnfoldSys.
|
inlineinherited |
IsDestructed.
Default equal comparison (objects are equal if they have the same address in memory).
More complicated classes might want to override this function.
Reimplemented in TGObject, TObjString, TPair, and TQCommand.
Definition at line 589 of file TObject.cxx.
|
virtualinherited |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
Reimplemented in ROOT::Experimental::XRooFit::xRooNode, ROOT::Internal::THnBaseBrowsable, TApplicationRemote, TAxis3D, TBaseClass, TBranch, TBranchClones, TBranchElement, TBranchObject, TBranchSTL, TBrowserObject, TCanvas, TClass, TCollection, TDatabasePDG, TDirectory, TFolder, TGeoManager, TGeometry, TGeoNode, TGeoNodeMatrix, TGeoOverlap, TGeoTrack, TGeoVolume, THbookFile, THbookKey, THnBase, TKey, TMapFile, TMultiDimFit, TNode, TPad, TPair, TParticleClassPDG, TPrincipal, TRemoteObject, TROOT, TRootIconList, TSPlot, TSystemDirectory, TTask, TTree, and TVirtualBranchBrowsable.
Definition at line 579 of file TObject.cxx.
|
inlinevirtualinherited |
Reimplemented in RooAbsArg, RooDouble, TCollection, TFileInfo, TGeoBranchArray, TGeoOverlap, TGFSFrameElement, TGLBFrameElement, TNamed, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TPave, TStructNode, TStructNodeProperty, TUri, and TUrl.
|
virtualinherited |
The ls function lists the contents of a class on stdout.
Ls output is typically much less verbose then Dump().
Reimplemented in ROOT::Detail::TSchemaRuleSet, ROOT::Experimental::XRooFit::xRooBrowser, ROOT::TSchemaRule, TAnnotation, TApplication, TBox, TCanvas, TChain, TChainElement, TClass, TClassTree, TCollection, TColor, TDirectory, TDirectoryFile, TEllipse, TFile, TFolder, TFree, TFriendElement, TFunction, TGeometry, TGeoNode, TGFrameElement, TGLayoutHints, THbookFile, THStack, TImage, TKey, TLine, TMapFile, TMarker, TNamed, TNode, TPad, TParameter< AParamType >, TParameter< Long64_t >, TPave, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TQCommand, TQConnection, TQConnectionList, TQSlot, TQUndoManager, TROOT, TStatistic, TStreamerBase, TStreamerElement, TStreamerInfo, TStreamerSTL, TTask, TText, TVirtualPad, and TVirtualStreamerInfo.
Definition at line 598 of file TObject.cxx.
|
inherited |
Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
Definition at line 1160 of file TObject.cxx.
|
protected |
multiply sparse matrix and a non-sparse matrix
| [in] | a | sparse matrix |
| [in] | b | matrix |
returns a new sparse matrix a*b.
A replacement for: new TMatrixDSparse(a,TMatrixDSparse::kMult,b) the root implementation had problems in older versions of root
Definition at line 760 of file TUnfold.cxx.
|
protected |
multiply two sparse matrices
| [in] | a | sparse matrix |
| [in] | b | sparse matrix |
returns a new sparse matrix a*b.
A replacement for: new TMatrixDSparse(a,TMatrixDSparse::kMult,b) the root implementation had problems in older versions of root
Definition at line 603 of file TUnfold.cxx.
|
protected |
calculate a sparse matrix product M1*V*M2T where the diagonal matrix V is given by a vector
| [in] | m1 | pointer to sparse matrix with dimension I*K |
| [in] | m2 | pointer to sparse matrix with dimension J*K |
| [in] | v | pointer to vector (matrix) with dimension K*1 |
returns a sparse matrix R with elements rij=ΣkM1ikVkM2jk
Definition at line 819 of file TUnfold.cxx.
|
protected |
multiply a transposed Sparse matrix with another Sparse matrix
| [in] | a | sparse matrix (to be transposed) |
| [in] | b | sparse matrix |
returns a new sparse matrix aT*b
this is a replacement for the root constructors new TMatrixDSparse(TMatrixDSparse(TMatrixDSparse::kTransposed,*a),TMatrixDSparse::kMult,*b)
Definition at line 677 of file TUnfold.cxx.
|
virtualinherited |
This method must be overridden to handle object notification (the base implementation is no-op).
Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.
For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.
Reimplemented in h1analysis, h1analysisTreeReader, TARInterruptHandler, TASInputHandler, TASInterruptHandler, TASLogHandler, TASSigPipeHandler, TBlinkTimer, TBranchElement, TBranchRef, TBreakLineCom, TBrowserTimer, TCollection, TDelCharCom, TDelTextCom, TFileHandler, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TGLRedrawTimer, TGTextEditHist, TGuiBldDragManagerRepeatTimer, TIdleTimer, TInsCharCom, TInsTextCom, TInterruptHandler, TLeafObject, TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TPopupDelayTimer, TProcessEventTimer, TRefTable, TRepeatTimer, TSBRepeatTimer, TSelector, TSelectorDraw, TSelectorEntries, TSignalHandler, TSingleShotCleaner, TSocketHandler, TStdExceptionHandler, TSysEvtHandler, TTermInputHandler, TThreadTimer, TTimeOutTimer, TTimer, TTipDelayTimer, TTree, TTreeFormula, TTreeFormulaManager, TTreeReader, TViewTimer, and TViewUpdateTimer.
Definition at line 618 of file TObject.cxx.
|
inherited |
Use this method to declare a method obsolete.
Specify as of which version the method is obsolete and as from which version it will be removed.
Definition at line 1169 of file TObject.cxx.
|
inherited |
Operator delete for sized deallocation.
Definition at line 1234 of file TObject.cxx.
|
inherited |
Operator delete.
Definition at line 1212 of file TObject.cxx.
|
inherited |
Only called by placement new when throwing an exception.
Definition at line 1266 of file TObject.cxx.
|
inherited |
Operator delete [] for sized deallocation.
Definition at line 1245 of file TObject.cxx.
|
inherited |
Operator delete [].
Definition at line 1223 of file TObject.cxx.
|
inherited |
Only called by placement new[] when throwing an exception.
Definition at line 1274 of file TObject.cxx.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
virtualinherited |
This method must be overridden if a class wants to paint itself.
The difference between Paint() and Draw() is that when a object draws itself it is added to the display list of the pad in which it is drawn (and automatically redrawn whenever the pad is redrawn). While paint just draws the object without adding it to the pad display list.
Reimplemented in ROOT::Experimental::RTreeMapPainter, ROOT::RGeoPainter, TAnnotation, TArrow, TASImage, TASPaletteEditor::LimitLine, TASPaletteEditor::PaintPalette, TAxis3D, TBits, TBox, TButton, TCanvas, TClassTree, TCollection, TColorWheel, TCrown, TDiamond, TDirectory, TEfficiency, TEllipse, TEveArrow, TEveCaloViz, TEveDigitSet, TEveGeoShape, TEveGeoTopNode, TEvePlot3D, TEvePointSet, TEveProjectionAxes, TEveScene, TEveShape, TEveStraightLineSet, TEveText, TEveTriangleSet, TExec, TF1, TF2, TF3, TFile, TFileDrawMap, TFrame, TGaxis, TGenerator, TGeoBoolNode, TGeoIntersection, TGeoNode, TGeoOverlap, TGeoPainter, TGeoPhysicalNode, TGeoShape, TGeoSubtraction, TGeoTrack, TGeoUnion, TGeoVGShape, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph2D, TGraph2DPainter, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGraphTime, TH1, THistPainter, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TNode, TNodeDiv, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TRatioPlot, TScatter2D, TScatter, TShape, TSpectrum2Painter, TSpider, TSpline, TSQLFile, TStyle, TText, TTreePerfStats, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualHistPainter, TVirtualPad, TWbox, and TXMLFile.
Definition at line 631 of file TObject.cxx.
|
virtualinherited |
Pop on object drawn in a pad to the top of the display list.
I.e. it will be drawn last and on top of all other primitives.
Reimplemented in TFrame, TPad, and TVirtualPad.
Definition at line 640 of file TObject.cxx.
|
virtualinherited |
This method must be overridden when a class wants to print itself.
Reimplemented in Roo1DTable, RooAbsArg, RooAbsBinning, RooAbsCollection, RooAbsData, RooAbsDataStore, RooAbsGenContext, RooCatType, RooCmdArg, RooCurve, RooEllipse, RooFitResult, RooGenFitStudy, RooHist, RooLinkedList, RooMsgService, RooNumGenConfig, RooNumIntConfig, RooPlot, RooSharedProperties, RooStats::ModelConfig, ROOT::Experimental::REveTrans, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, ROOT::v5::TFormula, RooWorkspace, TAnnotation, TApplicationRemote, TAttParticle, TBenchmark, TBits, TBox, TBranch, TBranchClones, TBranchElement, TBranchObject, TBranchRef, TBranchSTL, TChain, TClassTable, TCling, TCollection, TColor, TDatabasePDG, TDecompBase, TDecompBK, TDecompChol, TDecompLU, TDecompQRH, TDecompSparse, TDecompSVD, TDirectory, TEllipse, TEnv, TEventList, TEveTrans, TF1, TFile, TFileCacheRead, TFileCacheWrite, TFileCollection, TFileInfo, TFileInfoMeta, TFitResult, TFoamCell, TFoamVect, TFormula, TFunction, TGCompositeFrame, TGDMLMatrix, TGeoBatemanSol, TGeoBorderSurface, TGeoBranchArray, TGeoDecayChannel, TGeoElement, TGeoElementRN, TGeoElementTable, TGeoIsotope, TGeoMatrix, TGeoOpticalSurface, TGeoOverlap, TGeoPhysicalNode, TGeoRegion, TGeoSkinSurface, TGeoTessellated, TGeoTrack, TGeoVolume, TGeoVoxelFinder, TGFont, TGFontPool, TGFrame, TGFrameElement, TGGC, TGGCPool, TGLayoutHints, TGMimeTypes, TGPicture, TGPicturePool, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphErrors, TGraphMultiErrors, TGTextEdit, TGWindow, TH1, THashTable, THbookTree, THelix, THnBase, THStack, TInetAddress, TKey, TLegend, TLegendEntry, TLine, TLorentzVector, TMacro, TMapFile, TMarker, TMatrixTBase< Element >, TMatrixTBase< Double_t >, TMatrixTBase< Float_t >, TMemFile, TMessageHandler, TMultiDimFit, TMultiGraph, TMVA::Event, TMVA::Option< T >, TMVA::Option< T * >, TMVA::OptionBase, TMVA::PDEFoamCell, TMVA::PDEFoamVect, TMVA::TNeuron, TNamed, TObjectTable, TObjString, TPad, TParallelCoordRange, TParallelCoordVar, TParameter< AParamType >, TParameter< Long64_t >, TParticle, TParticleClassPDG, TParticlePDG, TPave, TPaveText, TPluginHandler, TPluginManager, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TPrincipal, TQpDataDens, TQpDataSparse, TQpVar, TQSlot, TQuaternion, TRolke, TRootBrowserHistoryCursor, TScatter2D, TScatter, TSpectrum2, TSpectrum3, TSpectrum, TSQLColumnInfo, TSQLFile, TSQLStructure, TSQLTableInfo, TStatistic, TStopwatch, TStreamerInfoActions::TActionSequence, TText, TTree, TTreeCache, TTreeCacheUnzip, TTreeIndex, TTreePerfStats, TUri, TUrl, TVector2, TVector3, TVectorT< Element >, TVectorT< Double_t >, TVectorT< Float_t >, TVirtualPad, TXMLFile, TXTRU, TZIPFile, and TZIPMember.
Definition at line 661 of file TObject.cxx.
|
virtualinherited |
Read contents of object with specified name from the current directory.
First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().
Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.
Definition at line 673 of file TObject.cxx.
|
virtualinherited |
Recursively remove this object from a list.
Typically implemented by classes that can contain multiple references to a same object.
Reimplemented in RooAbsCollection, RooAbsData, RooLinkedList, RooMCStudy, ROOT::Internal::TCheckHashRecursiveRemoveConsistency, ROOT::RBrowserDataCleanup, RooWorkspace, TBrowser, TChain, TCling, TCollection, TDialogCanvas, TDirectory, TEfficiency, TFileMerger, TFitEditor, TFolder, TFriendElement, TGedEditor, TGeometry, TGFileBrowser, TGraph2D, TGraph, TH1, TH1Editor, TH2Editor, THashList, THistPainter, THStack, TInspectCanvas, TLegend, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMultiGraph, TNode, TObjArray, TObjectRefSpy, TObjectSpy, TPad, TProcessID, TROOT, TRootBrowser, TRootBrowserHistory, TRootBrowserLite, TRootContextMenu, TTree, TTreePlayer, TViewPubDataMembers, TViewPubFunctions, and TVirtualPad.
Definition at line 684 of file TObject.cxx.
add regularisation conditions for a group of bins
| [in] | start | first bin number |
| [in] | step | step size |
| [in] | nbin | number of bins |
| [in] | regmode | regularisation mode (one of: kRegModeSize, kRegModeDerivative, kRegModeCurvature) |
add regularisation conditions for a group of equidistant bins. There are nbin bins, starting with bin start and with a distance of step between bins.
Return value: number of regularisation conditions which could not be added.
Conditions which are not added typically correspond to bin numbers where the truth can not be unfolded (either response matrix is empty or the data do not constrain).
Definition at line 2143 of file TUnfold.cxx.
| Int_t TUnfold::RegularizeBins2D | ( | int | start_bin, |
| int | step1, | ||
| int | nbin1, | ||
| int | step2, | ||
| int | nbin2, | ||
| ERegMode | regmode ) |
add regularisation conditions for 2d unfolding
| [in] | start_bin | first bin number |
| [in] | step1 | step size, 1st dimension |
| [in] | nbin1 | number of bins, 1st dimension |
| [in] | step2 | step size, 2nd dimension |
| [in] | nbin2 | number of bins, 2nd dimension |
| [in] | regmode | regularisation mode (one of: kRegModeSize, kRegModeDerivative, kRegModeCurvature) |
add regularisation conditions for a grid of bins. The start bin is start_bin. Along the first (second) dimension, there are nbin1 (nbin2) bins and adjacent bins are spaced by step1 (step2) units.
Return value: number of regularisation conditions which could not be added. Conditions which are not added typically correspond to bin numbers where the truth can not be unfolded (either response matrix is empty or the data do not constrain).
Definition at line 2204 of file TUnfold.cxx.
| Int_t TUnfold::RegularizeCurvature | ( | int | left_bin, |
| int | center_bin, | ||
| int | right_bin, | ||
| Double_t | scale_left = 1.0, | ||
| Double_t | scale_right = 1.0 ) |
add a regularisation condition on the curvature of three truth bin
| [in] | left_bin | bin number |
| [in] | center_bin | bin number |
| [in] | right_bin | bin number |
| [in] | scale_left | (default=1) scale factor |
| [in] | scale_right | (default=1) scale factor |
this adds one row to L, where the element left_bin takes the value -scale_left, the element right_bin takes the value -scale_right and the element center_bin takes the value scale_left+scale_right
return value: 0 if ok, 1 if the condition has not been added. Conditions which are not added typically correspond to bin numbers where the truth can not be unfolded (either response matrix is empty or the data do not constrain).
The RegularizeXXX() methods can be used to set up a custom matrix of regularisation conditions. In this case, start with an empty matrix L (argument regmode=kRegModeNone in the constructor)
Definition at line 2098 of file TUnfold.cxx.
add a regularisation condition on the difference of two truth bin
| [in] | left_bin | bin number |
| [in] | right_bin | bin number |
| [in] | scale | (default=1) scale factor |
this adds one row to L, where the element left_bin takes the value -scale and the element right_bin takes the value +scale
return value: 0 if ok, 1 if the condition has not been added. Conditions which are not added typically correspond to bin numbers where the truth can not be unfolded (either response matrix is empty or the data do not constrain).
The RegularizeXXX() methods can be used to set up a custom matrix of regularisation conditions. In this case, start with an empty matrix L (argument regmode=kRegModeNone in the constructor)
Definition at line 2059 of file TUnfold.cxx.
add a regularisation condition on the magnitude of a truth bin
| [in] | bin | bin number |
| [in] | scale | (default=1) scale factor |
this adds one row to L, where the element bin takes the value scale
return value: 0 if ok, 1 if the condition has not been added. Conditions which are not added typically correspond to bin numbers where the truth can not be unfolded (either response matrix is empty or the data do not constrain).
The RegularizeXXX() methods can be used to set up a custom matrix of regularisation conditions. In this case, start with an empty matrix L (argument regmode=kRegModeNone in the constructor)
Definition at line 2025 of file TUnfold.cxx.
|
virtualinherited |
Save this object in the file specified by filename.
otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.
The function is available via the object context menu.
Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.
Definition at line 708 of file TObject.cxx.
|
virtualinherited |
Save a primitive as a C++ statement(s) on output stream "out".
Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.
Definition at line 858 of file TObject.cxx.
|
staticprotectedinherited |
Save object constructor in the output stream "out".
Can be used as first statement when implementing SavePrimitive() method for the object
Definition at line 777 of file TObject.cxx.
|
staticprotectedinherited |
Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
Definition at line 845 of file TObject.cxx.
|
staticprotectedinherited |
Save array in the output stream "out" as vector.
Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()
Definition at line 796 of file TObject.cxx.
|
virtual |
scan the L curve, determine tau and unfold at the final value of tau
| [in] | nPoint | number of points used for the scan |
| [in] | tauMin | smallest tau value to study |
| [in] | tauMax | largest tau value to study. If tauMin=tauMax=nullptr, a scan interval is determined automatically. |
| [out] | lCurve | if nonzero, a new TGraph is returned, containing the L-curve |
| [out] | logTauX | if nonzero, a new TSpline is returned, to parameterize the L-curve's x-coordinates as a function of log10(tau) |
| [out] | logTauY | if nonzero, a new TSpline is returned, to parameterize the L-curve's y-coordinates as a function of log10(tau) |
| [out] | logTauCurvature | if nonzero, a new TSpline is returned of the L-curve curvature as a function of log10(tau) |
return value: the coordinate number in the logTauX,logTauY graphs corresponding to the "final" choice of tau
Recommendation: always check logTauCurvature, it should be a peaked function (similar to a Gaussian), the maximum corresponding to the final choice of tau. Also, check the lCurve it should be approximately L-shaped. If in doubt, adjust tauMin and tauMax until the results are satisfactory.
Definition at line 2558 of file TUnfold.cxx.
|
virtual |
minimize Stein's unbiased risk estimator "SURE" using successive calls to DoUnfold at various tau.
Optionally, also the L-curve and its curvature are calculated for comparison. See description of GetSURE() See e.g. arXiv:1612.09415 for the definition of SURE
| [in] | nPoint | : number of points |
| [in] | tauMin | : lower end of scan-range |
| [in] | tauMax | : upper end of scan-range |
| [out] | logTauSURE | : scan result, SURE as a function of log(tau) |
| [out] | df_chi2A | : parametric plot of DF against chi2A |
| [out] | lCurve | : parametric plot (lCurve) |
return value: index of the "best" point
if tauMin is less than zero of if tauMin is not loer than tauMax, then the scan range is determined automatically if tau=nullptr is included in the scan, then the first x-coordinate
Definition at line 3785 of file TUnfold.cxx.
| void TUnfold::SetBias | ( | const TH1 * | bias | ) |
set bias vector
| [in] | bias | histogram with new bias vector |
the initial bias vector is determined from the response matrix but may be changed by using this method
Definition at line 1895 of file TUnfold.cxx.
Set or unset the user status bits as specified in f.
Definition at line 888 of file TObject.cxx.
| void TUnfold::SetConstraint | ( | EConstraint | constraint | ) |
set type of area constraint
results of a previous unfolding are reset
Definition at line 3211 of file TUnfold.cxx.
|
virtualinherited |
Set drawing option for object.
This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().
Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.
Definition at line 871 of file TObject.cxx.
|
staticinherited |
Set destructor only flag.
Definition at line 1204 of file TObject.cxx.
| void TUnfold::SetEpsMatrix | ( | Double_t | eps | ) |
set numerical accuracy for Eigenvalue analysis when inverting matrices with rank problems
Definition at line 3703 of file TUnfold.cxx.
|
virtual |
Define input data for subsequent calls to DoUnfold(tau).
| [in] | input | input distribution with uncertainties |
| [in] | scaleBias | (default=nullptr) scale factor applied to the bias |
| [in] | oneOverZeroError | (default=nullptr) for bins with zero error, this number defines 1/error. |
| [in] | hist_vyy | (default=nullptr) if non-zero, this defines the data covariance matrix |
| [in] | hist_vyy_inv | (default=nullptr) if non-zero and hist_vyy is set, defines the inverse of the data covariance matrix. This feature can be useful for repeated unfoldings in cases where the inversion of the input covariance matrix is lengthy |
Return value: nError1+10000*nError2
Reimplemented in TUnfoldSys.
Definition at line 2274 of file TUnfold.cxx.
|
staticinherited |
Turn on/off tracking of objects in the TObjectTable.
Definition at line 1188 of file TObject.cxx.
|
virtualinherited |
Set the unique object id.
Definition at line 899 of file TObject.cxx.
|
overridevirtual |
Stream an object of class TObject.
Reimplemented from TObject.
Reimplemented in TUnfoldDensity, and TUnfoldSys.
|
inline |
|
virtualinherited |
Issue system error message.
Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.
Definition at line 1112 of file TObject.cxx.
|
virtualinherited |
|
virtualinherited |
Issue warning message.
Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.
Definition at line 1084 of file TObject.cxx.
|
virtualinherited |
Write this object to the current directory.
For more see the const version of this method.
Reimplemented in ROOT::TBufferMergerFile, TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.
Definition at line 989 of file TObject.cxx.
|
virtualinherited |
Write this object to the current directory.
The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".
Writing an object to a file involves the following steps:
Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.
If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().
The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.
An object is read from the file into memory via TKey::Read() or via TObject::Read().
The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.
Reimplemented in TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.
Definition at line 964 of file TObject.cxx.
|
protected |
|
private |
|
protected |
|
privateinherited |
|
private |
|
protected |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
staticprivateinherited |
|
protected |
|
private |
|
protected |
|
private |
|
protected |
|
private |
|
private |
|
protected |
|
protected |
|
privateinherited |
|
private |
|
private |
|
protected |
|
private |
|
protected |
