Logo ROOT   6.18/05
Reference Guide
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Static Private Attributes | Friends | List of all members
TMVA::PyMethodBase Class Referenceabstract

Definition at line 64 of file PyMethodBase.h.

Public Member Functions

 PyMethodBase (const TString &jobName, Types::EMVA methodType, const TString &methodTitle, DataSetInfo &dsi, const TString &theOption="")
 
 PyMethodBase (Types::EMVA methodType, DataSetInfo &dsi, const TString &weightFile)
 
virtual ~PyMethodBase ()
 
virtual const RankingCreateRanking ()=0
 
virtual void DeclareOptions ()=0
 
PyObjectEval (TString code)
 Evaluate Python code. More...
 
virtual Double_t GetMvaValue (Double_t *errLower=0, Double_t *errUpper=0)=0
 
Bool_t HasAnalysisType (Types::EAnalysisType type, UInt_t numberClasses, UInt_t numberTargets)=0
 
virtual void Init ()=0
 
virtual void ProcessOptions ()=0
 
virtual void Train ()=0
 
- Public Member Functions inherited from TMVA::MethodBase
 MethodBase (const TString &jobName, Types::EMVA methodType, const TString &methodTitle, DataSetInfo &dsi, const TString &theOption="")
 standard constructor More...
 
 MethodBase (Types::EMVA methodType, DataSetInfo &dsi, const TString &weightFile)
 constructor used for Testing + Application of the MVA, only (no training), using given WeightFiles More...
 
virtual ~MethodBase ()
 destructor More...
 
void AddOutput (Types::ETreeType type, Types::EAnalysisType analysisType)
 
TDirectoryBaseDir () const
 returns the ROOT directory where info/histograms etc of the corresponding MVA method instance are stored More...
 
virtual void CheckSetup ()
 check may be overridden by derived class (sometimes, eg, fitters are used which can only be implemented during training phase) More...
 
virtual const RankingCreateRanking ()=0
 
DataSetData () const
 
DataSetInfoDataInfo () const
 
virtual void DeclareCompatibilityOptions ()
 options that are used ONLY for the READER to ensure backward compatibility they are hence without any effect (the reader is only reading the training options that HAD been used at the training of the .xml weight file at hand More...
 
virtual void DeclareOptions ()=0
 
void DisableWriting (Bool_t setter)
 
Bool_t DoMulticlass () const
 
Bool_t DoRegression () const
 
void ExitFromTraining ()
 
Types::EAnalysisType GetAnalysisType () const
 
UInt_t GetCurrentIter ()
 
virtual Double_t GetEfficiency (const TString &, Types::ETreeType, Double_t &err)
 fill background efficiency (resp. More...
 
const EventGetEvent () const
 
const EventGetEvent (const TMVA::Event *ev) const
 
const EventGetEvent (Long64_t ievt) const
 
const EventGetEvent (Long64_t ievt, Types::ETreeType type) const
 
const std::vector< TMVA::Event * > & GetEventCollection (Types::ETreeType type)
 returns the event collection (i.e. More...
 
TFileGetFile () const
 
const TStringGetInputLabel (Int_t i) const
 
const char * GetInputTitle (Int_t i) const
 
const TStringGetInputVar (Int_t i) const
 
TMultiGraphGetInteractiveTrainingError ()
 
const TStringGetJobName () const
 
virtual Double_t GetKSTrainingVsTest (Char_t SorB, TString opt="X")
 
virtual Double_t GetMaximumSignificance (Double_t SignalEvents, Double_t BackgroundEvents, Double_t &optimal_significance_value) const
 plot significance, \( \frac{S}{\sqrt{S^2 + B^2}} \), curve for given number of signal and background events; returns cut for maximum significance also returned via reference is the maximum significance More...
 
UInt_t GetMaxIter ()
 
Double_t GetMean (Int_t ivar) const
 
const TStringGetMethodName () const
 
Types::EMVA GetMethodType () const
 
TString GetMethodTypeName () const
 
virtual TMatrixD GetMulticlassConfusionMatrix (Double_t effB, Types::ETreeType type)
 Construct a confusion matrix for a multiclass classifier. More...
 
virtual std::vector< Float_tGetMulticlassEfficiency (std::vector< std::vector< Float_t > > &purity)
 
virtual std::vector< Float_tGetMulticlassTrainingEfficiency (std::vector< std::vector< Float_t > > &purity)
 
virtual const std::vector< Float_t > & GetMulticlassValues ()
 
Double_t GetMvaValue (const TMVA::Event *const ev, Double_t *err=0, Double_t *errUpper=0)
 
virtual Double_t GetMvaValue (Double_t *errLower=0, Double_t *errUpper=0)=0
 
const char * GetName () const
 
UInt_t GetNEvents () const
 temporary event when testing on a different DataSet than the own one More...
 
UInt_t GetNTargets () const
 
UInt_t GetNvar () const
 
UInt_t GetNVariables () const
 
virtual Double_t GetProba (const Event *ev)
 
virtual Double_t GetProba (Double_t mvaVal, Double_t ap_sig)
 compute likelihood ratio More...
 
const TString GetProbaName () const
 
virtual Double_t GetRarity (Double_t mvaVal, Types::ESBType reftype=Types::kBackground) const
 compute rarity: More...
 
virtual void GetRegressionDeviation (UInt_t tgtNum, Types::ETreeType type, Double_t &stddev, Double_t &stddev90Percent) const
 
virtual const std::vector< Float_t > & GetRegressionValues ()
 
const std::vector< Float_t > & GetRegressionValues (const TMVA::Event *const ev)
 
Double_t GetRMS (Int_t ivar) const
 
virtual Double_t GetROCIntegral (PDF *pdfS=0, PDF *pdfB=0) const
 calculate the area (integral) under the ROC curve as a overall quality measure of the classification More...
 
virtual Double_t GetROCIntegral (TH1D *histS, TH1D *histB) const
 calculate the area (integral) under the ROC curve as a overall quality measure of the classification More...
 
virtual Double_t GetSeparation (PDF *pdfS=0, PDF *pdfB=0) const
 compute "separation" defined as More...
 
virtual Double_t GetSeparation (TH1 *, TH1 *) const
 compute "separation" defined as More...
 
Double_t GetSignalReferenceCut () const
 
Double_t GetSignalReferenceCutOrientation () const
 
virtual Double_t GetSignificance () const
 compute significance of mean difference More...
 
const EventGetTestingEvent (Long64_t ievt) const
 
Double_t GetTestTime () const
 
const TStringGetTestvarName () const
 
virtual Double_t GetTrainingEfficiency (const TString &)
 
const EventGetTrainingEvent (Long64_t ievt) const
 
UInt_t GetTrainingROOTVersionCode () const
 
TString GetTrainingROOTVersionString () const
 calculates the ROOT version string from the training version code on the fly More...
 
UInt_t GetTrainingTMVAVersionCode () const
 
TString GetTrainingTMVAVersionString () const
 calculates the TMVA version string from the training version code on the fly More...
 
Double_t GetTrainTime () const
 
TransformationHandlerGetTransformationHandler (Bool_t takeReroutedIfAvailable=true)
 
const TransformationHandlerGetTransformationHandler (Bool_t takeReroutedIfAvailable=true) const
 
TString GetWeightFileName () const
 retrieve weight file name More...
 
Double_t GetXmax (Int_t ivar) const
 
Double_t GetXmin (Int_t ivar) const
 
Bool_t HasMVAPdfs () const
 
virtual void Init ()=0
 
void InitIPythonInteractive ()
 
Bool_t IsModelPersistence ()
 
virtual Bool_t IsSignalLike ()
 uses a pre-set cut on the MVA output (SetSignalReferenceCut and SetSignalReferenceCutOrientation) for a quick determination if an event would be selected as signal or background More...
 
virtual Bool_t IsSignalLike (Double_t mvaVal)
 uses a pre-set cut on the MVA output (SetSignalReferenceCut and SetSignalReferenceCutOrientation) for a quick determination if an event with this mva output value would be selected as signal or background More...
 
Bool_t IsSilentFile ()
 
virtual void MakeClass (const TString &classFileName=TString("")) const
 create reader class for method (classification only at present) More...
 
TDirectoryMethodBaseDir () const
 returns the ROOT directory where all instances of the corresponding MVA method are stored More...
 
virtual std::map< TString, Double_tOptimizeTuningParameters (TString fomType="ROCIntegral", TString fitType="FitGA")
 call the Optimizer with the set of parameters and ranges that are meant to be tuned. More...
 
void PrintHelpMessage () const
 prints out method-specific help method More...
 
virtual void ProcessOptions ()=0
 
void ProcessSetup ()
 process all options the "CheckForUnusedOptions" is done in an independent call, since it may be overridden by derived class (sometimes, eg, fitters are used which can only be implemented during training phase) More...
 
void ReadStateFromFile ()
 Function to write options and weights to file. More...
 
void ReadStateFromStream (std::istream &tf)
 read the header from the weight files of the different MVA methods More...
 
void ReadStateFromStream (TFile &rf)
 write reference MVA distributions (and other information) to a ROOT type weight file More...
 
void ReadStateFromXMLString (const char *xmlstr)
 for reading from memory More...
 
void RerouteTransformationHandler (TransformationHandler *fTargetTransformation)
 
virtual void Reset ()
 
virtual void SetAnalysisType (Types::EAnalysisType type)
 
void SetBaseDir (TDirectory *methodDir)
 
void SetFile (TFile *file)
 
void SetMethodBaseDir (TDirectory *methodDir)
 
void SetMethodDir (TDirectory *methodDir)
 
void SetModelPersistence (Bool_t status)
 
void SetSignalReferenceCut (Double_t cut)
 
void SetSignalReferenceCutOrientation (Double_t cutOrientation)
 
void SetSilentFile (Bool_t status)
 
void SetTestTime (Double_t testTime)
 
void SetTestvarName (const TString &v="")
 
void SetTrainTime (Double_t trainTime)
 
virtual void SetTuneParameters (std::map< TString, Double_t > tuneParameters)
 set the tuning parameters according to the argument This is just a dummy . More...
 
void SetupMethod ()
 setup of methods More...
 
virtual void TestClassification ()
 initialization More...
 
virtual void TestMulticlass ()
 test multiclass classification More...
 
virtual void TestRegression (Double_t &bias, Double_t &biasT, Double_t &dev, Double_t &devT, Double_t &rms, Double_t &rmsT, Double_t &mInf, Double_t &mInfT, Double_t &corr, Types::ETreeType type)
 calculate <sum-of-deviation-squared> of regression output versus "true" value from test sample More...
 
virtual void Train ()=0
 
bool TrainingEnded ()
 
void TrainMethod ()
 
virtual void WriteEvaluationHistosToFile (Types::ETreeType treetype)
 writes all MVA evaluation histograms to file More...
 
virtual void WriteMonitoringHistosToFile () const
 write special monitoring histograms to file dummy implementation here --------------— More...
 
void WriteStateToFile () const
 write options and weights to file note that each one text file for the main configuration information and one ROOT file for ROOT objects are created More...
 
- Public Member Functions inherited from TMVA::IMethod
 IMethod ()
 
virtual ~IMethod ()
 
virtual const RankingCreateRanking ()=0
 
virtual void DeclareOptions ()=0
 
virtual Double_t GetMvaValue (Double_t *err=0, Double_t *errUpper=0)=0
 
virtual const char * GetName () const =0
 
virtual Bool_t HasAnalysisType (Types::EAnalysisType type, UInt_t numberClasses, UInt_t numberTargets)=0
 
virtual void Init ()=0
 
virtual void MakeClass (const TString &classFileName=TString("")) const =0
 
virtual void PrintHelpMessage () const =0
 
virtual void ProcessOptions ()=0
 
virtual void ReadWeightsFromStream (std::istream &)=0
 
virtual void Train (void)=0
 
virtual void WriteMonitoringHistosToFile (void) const =0
 
- Public Member Functions inherited from TMVA::Configurable
 Configurable (const TString &theOption="")
 constructor More...
 
virtual ~Configurable ()
 default destructor More...
 
void AddOptionsXMLTo (void *parent) const
 write options to XML file More...
 
template<class T >
void AddPreDefVal (const T &)
 
template<class T >
void AddPreDefVal (const TString &optname, const T &)
 
void CheckForUnusedOptions () const
 checks for unused options in option string More...
 
template<class T >
TMVA::OptionBaseDeclareOptionRef (T &ref, const TString &name, const TString &desc)
 
template<class T >
OptionBaseDeclareOptionRef (T &ref, const TString &name, const TString &desc="")
 
template<class T >
TMVA::OptionBaseDeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc)
 
template<class T >
OptionBaseDeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc="")
 
const char * GetConfigDescription () const
 
const char * GetConfigName () const
 
const TStringGetOptions () const
 
MsgLoggerLog () const
 
virtual void ParseOptions ()
 options parser More...
 
void PrintOptions () const
 prints out the options set in the options string and the defaults More...
 
void ReadOptionsFromStream (std::istream &istr)
 read option back from the weight file More...
 
void ReadOptionsFromXML (void *node)
 
void SetConfigDescription (const char *d)
 
void SetConfigName (const char *n)
 
void SetMsgType (EMsgType t)
 
void SetOptions (const TString &s)
 
void WriteOptionsToStream (std::ostream &o, const TString &prefix) const
 write options to output stream (e.g. in writing the MVA weight files More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE 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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Static Public Member Functions

static TString Py_GetProgramName ()
 Get program name from Python interpreter. More...
 
static void PyFinalize ()
 
static void PyInitialize ()
 Initialize Python interpreter. More...
 
static int PyIsInitialized ()
 Check Python interpreter initialization status. More...
 
static void PySetProgramName (TString name)
 Set program name for Python interpeter. More...
 
static void Serialize (TString file, PyObject *classifier)
 Serialize Python object. More...
 
static Int_t UnSerialize (TString file, PyObject **obj)
 Unserialize Python object. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Protected Member Functions

virtual void AddWeightsXMLTo (void *parent) const =0
 
virtual std::vector< Double_tGetMvaValues (Long64_t firstEvt=0, Long64_t lastEvt=-1, Bool_t logProgress=false)=0
 get all the MVA values for the events of the current Data type More...
 
void PyRunString (TString code, TString errorMessage="Failed to run python code", int start=Py_single_input)
 Execute Python code from string. More...
 
virtual void ReadModelFromFile ()=0
 
virtual void ReadWeightsFromStream (std::istream &)=0
 
virtual void ReadWeightsFromStream (TFile &)
 
virtual void ReadWeightsFromXML (void *wghtnode)=0
 
- Protected Member Functions inherited from TMVA::MethodBase
virtual void AddWeightsXMLTo (void *parent) const =0
 
const TStringGetInternalVarName (Int_t ivar) const
 
virtual std::vector< Double_tGetMvaValues (Long64_t firstEvt=0, Long64_t lastEvt=-1, Bool_t logProgress=false)
 get all the MVA values for the events of the current Data type More...
 
const TStringGetOriginalVarName (Int_t ivar) const
 
const TStringGetWeightFileDir () const
 
Bool_t HasTrainingTree () const
 
Bool_t Help () const
 
Bool_t IgnoreEventsWithNegWeightsInTraining () const
 
Bool_t IsConstructedFromWeightFile () const
 
Bool_t IsNormalised () const
 
virtual void MakeClassSpecific (std::ostream &, const TString &="") const
 
virtual void MakeClassSpecificHeader (std::ostream &, const TString &="") const
 
void NoErrorCalc (Double_t *const err, Double_t *const errUpper)
 
virtual void ReadWeightsFromStream (std::istream &)=0
 
virtual void ReadWeightsFromStream (TFile &)
 
virtual void ReadWeightsFromXML (void *wghtnode)=0
 
void SetNormalised (Bool_t norm)
 
void SetWeightFileDir (TString fileDir)
 set directory of weight file More...
 
void SetWeightFileName (TString)
 set the weight file name (depreciated) More...
 
void Statistics (Types::ETreeType treeType, const TString &theVarName, Double_t &, Double_t &, Double_t &, Double_t &, Double_t &, Double_t &)
 calculates rms,mean, xmin, xmax of the event variable this can be either done for the variables as they are or for normalised variables (in the range of 0-1) if "norm" is set to kTRUE More...
 
Bool_t TxtWeightsOnly () const
 
Bool_t Verbose () const
 
- Protected Member Functions inherited from TMVA::IMethod
virtual void GetHelpMessage () const =0
 
virtual void MakeClassSpecific (std::ostream &, const TString &) const =0
 
- Protected Member Functions inherited from TMVA::Configurable
void EnableLooseOptions (Bool_t b=kTRUE)
 
const TStringGetReferenceFile () const
 
Bool_t LooseOptionCheckingEnabled () const
 
void ResetSetFlag ()
 resets the IsSet flag for all declare options to be called before options are read from stream More...
 
void WriteOptionsReferenceToFile ()
 write complete options to output stream More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

Protected Attributes

PyObjectfClassifier
 
PyObjectfLocalNS
 
PyObjectfModule
 
PyObjectfPyReturn
 
PyArrayObject * fTrainData
 
PyArrayObject * fTrainDataClasses
 
PyArrayObject * fTrainDataWeights
 
- Protected Attributes inherited from TMVA::MethodBase
Types::EAnalysisType fAnalysisType
 
UInt_t fBackgroundClass
 
bool fExitFromTraining = false
 
std::vector< TString > * fInputVars
 
IPythonInteractivefInteractive = nullptr
 
UInt_t fIPyCurrentIter = 0
 
UInt_t fIPyMaxIter = 0
 
std::vector< Float_t > * fMulticlassReturnVal
 
Int_t fNbins
 
Int_t fNbinsH
 
Int_t fNbinsMVAoutput
 
RankingfRanking
 
std::vector< Float_t > * fRegressionReturnVal
 
ResultsfResults
 
UInt_t fSignalClass
 
- Protected Attributes inherited from TMVA::Configurable
MsgLoggerfLogger
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Static Protected Attributes

static PyObjectfGlobalNS = NULL
 
static PyObjectfMain = NULL
 
static PyObjectfModulePickle = NULL
 
static PyObjectfPickleDumps = NULL
 
static PyObjectfPickleLoads = NULL
 

Static Private Attributes

static PyObjectfEval = NULL
 
static PyObjectfModuleBuiltin = NULL
 
static PyObjectfOpen = NULL
 

Friends

class Factory
 

Additional Inherited Members

- Public Types inherited from TMVA::MethodBase
enum  EWeightFileType { kROOT =0 , kTEXT }
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) ,
  kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13)
}
 
- Public Attributes inherited from TMVA::MethodBase
Bool_t fSetupCompleted
 
const EventfTmpEvent
 

#include <TMVA/PyMethodBase.h>

Inheritance diagram for TMVA::PyMethodBase:
[legend]

Constructor & Destructor Documentation

◆ PyMethodBase() [1/2]

PyMethodBase::PyMethodBase ( const TString jobName,
Types::EMVA  methodType,
const TString methodTitle,
DataSetInfo dsi,
const TString theOption = "" 
)

Definition at line 62 of file PyMethodBase.cxx.

◆ PyMethodBase() [2/2]

PyMethodBase::PyMethodBase ( Types::EMVA  methodType,
DataSetInfo dsi,
const TString weightFile 
)

Definition at line 80 of file PyMethodBase.cxx.

◆ ~PyMethodBase()

PyMethodBase::~PyMethodBase ( )
virtual

Definition at line 98 of file PyMethodBase.cxx.

Member Function Documentation

◆ AddWeightsXMLTo()

virtual void TMVA::PyMethodBase::AddWeightsXMLTo ( void parent) const
protectedpure virtual

◆ CreateRanking()

virtual const Ranking * TMVA::PyMethodBase::CreateRanking ( )
pure virtual

◆ DeclareOptions()

virtual void TMVA::PyMethodBase::DeclareOptions ( )
pure virtual

◆ Eval()

PyObject * PyMethodBase::Eval ( TString  code)

Evaluate Python code.

Parameters
[in]codePython code as string
Returns
Python object from evaluation of code line

Take a Python code as input and evaluate it in the local namespace. Then, return the result as Python object.

Definition at line 111 of file PyMethodBase.cxx.

◆ GetMvaValue()

virtual Double_t TMVA::PyMethodBase::GetMvaValue ( Double_t errLower = 0,
Double_t errUpper = 0 
)
pure virtual

◆ GetMvaValues()

virtual std::vector< Double_t > TMVA::PyMethodBase::GetMvaValues ( Long64_t  firstEvt = 0,
Long64_t  lastEvt = -1,
Bool_t  logProgress = false 
)
protectedpure virtual

get all the MVA values for the events of the current Data type

Reimplemented from TMVA::MethodBase.

Implemented in TMVA::MethodPyKeras, TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, and TMVA::MethodPyRandomForest.

◆ HasAnalysisType()

Bool_t TMVA::PyMethodBase::HasAnalysisType ( Types::EAnalysisType  type,
UInt_t  numberClasses,
UInt_t  numberTargets 
)
pure virtual

◆ Init()

virtual void TMVA::PyMethodBase::Init ( )
pure virtual

◆ ProcessOptions()

virtual void TMVA::PyMethodBase::ProcessOptions ( )
pure virtual

◆ Py_GetProgramName()

TString PyMethodBase::Py_GetProgramName ( )
static

Get program name from Python interpreter.

Returns
Program name

Definition at line 237 of file PyMethodBase.cxx.

◆ PyFinalize()

void PyMethodBase::PyFinalize ( )
static

Definition at line 199 of file PyMethodBase.cxx.

◆ PyInitialize()

void PyMethodBase::PyInitialize ( )
static

Initialize Python interpreter.

NOTE: We introduce a shared global namespace fGlobalNS, but using a private local namespace fLocalNS. This prohibits the interference of instances of the same method with the same factory, e.g., by overriding variables in the same local namespace.

Definition at line 128 of file PyMethodBase.cxx.

◆ PyIsInitialized()

int PyMethodBase::PyIsInitialized ( )
static

Check Python interpreter initialization status.

Returns
Boolean whether interpreter is initialized

Definition at line 248 of file PyMethodBase.cxx.

◆ PyRunString()

void PyMethodBase::PyRunString ( TString  code,
TString  errorMessage = "Failed to run python code",
int  start = Py_single_input 
)
protected

Execute Python code from string.

Parameters
[in]codePython code as string
[in]errorMessageError message which shall be shown if the execution fails
[in]startStart symbol

Helper function to run python code from string in local namespace with error handling start defines the start symbol defined in PyRun_String (Py_eval_input, Py_single_input, Py_file_input)

Definition at line 320 of file PyMethodBase.cxx.

◆ PySetProgramName()

void PyMethodBase::PySetProgramName ( TString  name)
static

Set program name for Python interpeter.

Parameters
[in]nameProgram name

Definition at line 214 of file PyMethodBase.cxx.

◆ ReadModelFromFile()

virtual void TMVA::PyMethodBase::ReadModelFromFile ( )
protectedpure virtual

◆ ReadWeightsFromStream() [1/2]

virtual void TMVA::PyMethodBase::ReadWeightsFromStream ( std::istream &  )
protectedpure virtual

◆ ReadWeightsFromStream() [2/2]

virtual void TMVA::PyMethodBase::ReadWeightsFromStream ( TFile )
inlineprotectedvirtual

Reimplemented from TMVA::MethodBase.

Reimplemented in TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyKeras, and TMVA::MethodPyRandomForest.

Definition at line 111 of file PyMethodBase.h.

◆ ReadWeightsFromXML()

virtual void TMVA::PyMethodBase::ReadWeightsFromXML ( void wghtnode)
protectedpure virtual

◆ Serialize()

void PyMethodBase::Serialize ( TString  path,
PyObject obj 
)
static

Serialize Python object.

Parameters
[in]pathPath where object is written to file
[in]objPython object

The input Python object is serialized and written to a file. The Python module pickle is used to do so.

Definition at line 267 of file PyMethodBase.cxx.

◆ Train()

virtual void TMVA::PyMethodBase::Train ( )
pure virtual

◆ UnSerialize()

Int_t PyMethodBase::UnSerialize ( TString  path,
PyObject **  obj 
)
static

Unserialize Python object.

Parameters
[in]pathPath to serialized Python object
[in]objPython object where the unserialized Python object is loaded
Returns
Error code

Definition at line 289 of file PyMethodBase.cxx.

Friends And Related Function Documentation

◆ Factory

friend class Factory
friend

Definition at line 66 of file PyMethodBase.h.

Member Data Documentation

◆ fClassifier

PyObject* TMVA::PyMethodBase::fClassifier
protected

Definition at line 120 of file PyMethodBase.h.

◆ fEval

PyObject * PyMethodBase::fEval = NULL
staticprivate

Definition at line 133 of file PyMethodBase.h.

◆ fGlobalNS

PyObject * PyMethodBase::fGlobalNS = NULL
staticprotected

Definition at line 142 of file PyMethodBase.h.

◆ fLocalNS

PyObject* TMVA::PyMethodBase::fLocalNS
protected

Definition at line 143 of file PyMethodBase.h.

◆ fMain

PyObject * PyMethodBase::fMain = NULL
staticprotected

Definition at line 141 of file PyMethodBase.h.

◆ fModule

PyObject* TMVA::PyMethodBase::fModule
protected

Definition at line 119 of file PyMethodBase.h.

◆ fModuleBuiltin

PyObject * PyMethodBase::fModuleBuiltin = NULL
staticprivate

Definition at line 132 of file PyMethodBase.h.

◆ fModulePickle

PyObject * PyMethodBase::fModulePickle = NULL
staticprotected

Definition at line 137 of file PyMethodBase.h.

◆ fOpen

PyObject * PyMethodBase::fOpen = NULL
staticprivate

Definition at line 134 of file PyMethodBase.h.

◆ fPickleDumps

PyObject * PyMethodBase::fPickleDumps = NULL
staticprotected

Definition at line 138 of file PyMethodBase.h.

◆ fPickleLoads

PyObject * PyMethodBase::fPickleLoads = NULL
staticprotected

Definition at line 139 of file PyMethodBase.h.

◆ fPyReturn

PyObject* TMVA::PyMethodBase::fPyReturn
protected

Definition at line 126 of file PyMethodBase.h.

◆ fTrainData

PyArrayObject* TMVA::PyMethodBase::fTrainData
protected

Definition at line 122 of file PyMethodBase.h.

◆ fTrainDataClasses

PyArrayObject* TMVA::PyMethodBase::fTrainDataClasses
protected

Definition at line 124 of file PyMethodBase.h.

◆ fTrainDataWeights

PyArrayObject* TMVA::PyMethodBase::fTrainDataWeights
protected

Definition at line 123 of file PyMethodBase.h.

Libraries for TMVA::PyMethodBase:
[legend]

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