TMVAEvaluator Class Reference

#include <TMVAEvaluator.h>

Public Member Functions
float	evaluate (const std::map< std::string, float > &inputs, bool useSpectators=false) const
float	evaluateGBRForest (const std::map< std::string, float > &inputs) const
float	evaluateTMVA (const std::map< std::string, float > &inputs, bool useSpectators) const
void	initialize (const std::string &options, const std::string &method, const std::string &weightFile, const std::vector< std::string > &variables, const std::vector< std::string > &spectators, bool useGBRForest=false, bool useAdaBoost=false)
void	initializeGBRForest (const GBRForest *gbrForest, const std::vector< std::string > &variables, const std::vector< std::string > &spectators, bool useAdaBoost=false)
	TMVAEvaluator ()

Private Attributes
std::mutex	m_mutex
std::shared_ptr< const GBRForest >	mGBRForest
bool	mIsInitialized
std::string	mMethod
std::unique_ptr< TMVA::Reader >	mReader
std::map< std::string, std::pair< size_t, float > >	mSpectators
bool	mUseAdaBoost
bool	mUsingGBRForest
std::map< std::string, std::pair< size_t, float > >	mVariables

Detailed Description

Definition at line 16 of file TMVAEvaluator.h.

Constructor & Destructor Documentation

TMVAEvaluator()

TMVAEvaluator::TMVAEvaluator

(

)

Definition at line 11 of file TMVAEvaluator.cc.

: mIsInitialized(false), mUsingGBRForest(false), mUseAdaBoost(false) {}

Member Function Documentation

evaluate()

float TMVAEvaluator::evaluate	(	const std::map< std::string, float > &	inputs,
		bool	useSpectators = false
	)		const

Definition at line 134 of file TMVAEvaluator.cc.

References evaluateGBRForest(), evaluateTMVA(), PixelMapPlotter::inputs, mIsInitialized, mSpectators, mUsingGBRForest, mVariables, and relativeConstraints::value.

                                                                                              {
  // default value
  float value = -99.;

  if (!mIsInitialized) {
    edm::LogError("InitializationError") << "TMVAEvaluator not properly initialized.";
    return value;
  }

  if (useSpectators && inputs.size() < (mVariables.size() + mSpectators.size())) {
    edm::LogError("MissingInputs") << "Too few inputs provided (" << inputs.size() << " provided but "
                                   << mVariables.size() << " input and " << mSpectators.size()
                                   << " spectator variables expected).";
    return value;
  } else if (inputs.size() < mVariables.size()) {
    edm::LogError("MissingInputVariable(s)") << "Too few input variables provided (" << inputs.size()
                                             << " provided but " << mVariables.size() << " expected).";
    return value;
  }

  if (mUsingGBRForest) {
    if (useSpectators)
      edm::LogWarning("UnsupportedFunctionality")
          << "Use of spectator variables with GBRForest is not supported. Spectator variables will be ignored.";
    value = evaluateGBRForest(inputs);
  } else
    value = evaluateTMVA(inputs, useSpectators);

  return value;
}

evaluateGBRForest()

float TMVAEvaluator::evaluateGBRForest

(

const std::map< std::string, float > &

inputs

)

const

Definition at line 109 of file TMVAEvaluator.cc.

References PixelMapPlotter::inputs, mGBRForest, mUseAdaBoost, mVariables, and relativeConstraints::value.

Referenced by evaluate().

                                                                                   {
  // default value
  float value = -99.;

  std::unique_ptr<float[]> vars(new float[mVariables.size()]);  // allocate n floats

  // set the input variable values
  for (auto it = mVariables.begin(); it != mVariables.end(); ++it) {
    if (inputs.count(it->first) > 0)
      vars[it->second.first] = inputs.at(it->first);
    else
      edm::LogError("MissingInputVariable")
          << "Input variable " << it->first
          << " is missing from the list of inputs. The returned discriminator value might not be sensible.";
  }

  // evaluate the MVA
  if (mUseAdaBoost)
    value = mGBRForest->GetAdaBoostClassifier(vars.get());
  else
    value = mGBRForest->GetGradBoostClassifier(vars.get());

  return value;
}

evaluateTMVA()

float TMVAEvaluator::evaluateTMVA	(	const std::map< std::string, float > &	inputs,
		bool	useSpectators
	)		const

Definition at line 73 of file TMVAEvaluator.cc.

References PixelMapPlotter::inputs, CommonMethods::lock(), m_mutex, mMethod, mReader, mSpectators, mVariables, and relativeConstraints::value.

Referenced by evaluate().

                                                                                                  {
  // default value
  float value = -99.;

  // TMVA::Reader is not thread safe
  std::lock_guard<std::mutex> lock(m_mutex);

  // set the input variable values
  for (auto it = mVariables.begin(); it != mVariables.end(); ++it) {
    if (inputs.count(it->first) > 0)
      it->second.second = inputs.at(it->first);
    else
      edm::LogError("MissingInputVariable")
          << "Input variable " << it->first
          << " is missing from the list of inputs. The returned discriminator value might not be sensible.";
  }

  // if using spectator variables
  if (useSpectators) {
    // set the spectator variable values
    for (auto it = mSpectators.begin(); it != mSpectators.end(); ++it) {
      if (inputs.count(it->first) > 0)
        it->second.second = inputs.at(it->first);
      else
        edm::LogError("MissingSpectatorVariable")
            << "Spectator variable " << it->first
            << " is missing from the list of inputs. The returned discriminator value might not be sensible.";
    }
  }

  // evaluate the MVA
  value = mReader->EvaluateMVA(mMethod.c_str());

  return value;
}

initialize()

void TMVAEvaluator::initialize	(	const std::string &	options,
		const std::string &	method,
		const std::string &	weightFile,
		const std::vector< std::string > &	variables,
		const std::vector< std::string > &	spectators,
		bool	useGBRForest = false,
		bool	useAdaBoost = false
	)

Definition at line 13 of file TMVAEvaluator.cc.

References createGBRForest(), reco::details::loadTMVAWeights(), AlcaSiPixelAliHarvester0T_cff::method, mGBRForest, mIsInitialized, mMethod, mReader, mSpectators, mUseAdaBoost, mUsingGBRForest, mVariables, candidateCombinedMVAV2Computer_cfi::spectators, HLT_2023v12_cff::useAdaBoost, HLT_2023v12_cff::useGBRForest, L1TEGammaDiff_cfi::variables, and HLT_2023v12_cff::weightFile.

                                                 {
  // initialize the TMVA reader
  mReader = std::make_unique<TMVA::Reader>(options.c_str());
  mReader->SetVerbose(false);
  mMethod = method;

  // add input variables
  for (std::vector<std::string>::const_iterator it = variables.begin(); it != variables.end(); ++it) {
    mVariables.insert(std::make_pair(*it, std::make_pair(it - variables.begin(), 0.)));
    mReader->AddVariable(it->c_str(), &(mVariables.at(*it).second));
  }

  // add spectator variables
  for (std::vector<std::string>::const_iterator it = spectators.begin(); it != spectators.end(); ++it) {
    mSpectators.insert(std::make_pair(*it, std::make_pair(it - spectators.begin(), 0.)));
    mReader->AddSpectator(it->c_str(), &(mSpectators.at(*it).second));
  }

  // load the TMVA weights
  reco::details::loadTMVAWeights(mReader.get(), mMethod, weightFile);

  if (useGBRForest) {
    mGBRForest = createGBRForest(weightFile);

    // now can free some memory
    mReader.reset(nullptr);

    mUsingGBRForest = true;
    mUseAdaBoost = useAdaBoost;
  }

  mIsInitialized = true;
}

initializeGBRForest()

void TMVAEvaluator::initializeGBRForest	(	const GBRForest *	gbrForest,
		const std::vector< std::string > &	variables,
		const std::vector< std::string > &	spectators,
		bool	useAdaBoost = false
	)

Definition at line 53 of file TMVAEvaluator.cc.

References mGBRForest, mIsInitialized, mSpectators, mUseAdaBoost, mUsingGBRForest, mVariables, candidateCombinedMVAV2Computer_cfi::spectators, HLT_2023v12_cff::useAdaBoost, and L1TEGammaDiff_cfi::variables.

                                                          {
  // add input variables
  for (std::vector<std::string>::const_iterator it = variables.begin(); it != variables.end(); ++it)
    mVariables.insert(std::make_pair(*it, std::make_pair(it - variables.begin(), 0.)));

  // add spectator variables
  for (std::vector<std::string>::const_iterator it = spectators.begin(); it != spectators.end(); ++it)
    mSpectators.insert(std::make_pair(*it, std::make_pair(it - spectators.begin(), 0.)));

  // do not take ownership if getting GBRForest from an external source
  mGBRForest = std::shared_ptr<const GBRForest>(gbrForest, [](const GBRForest*) {});

  mIsInitialized = true;
  mUsingGBRForest = true;
  mUseAdaBoost = useAdaBoost;
}

Member Data Documentation

m_mutex

std::mutex TMVAEvaluator::m_mutex

mutableprivate

Definition at line 43 of file TMVAEvaluator.h.

Referenced by evaluateTMVA().

mGBRForest

std::shared_ptr<const GBRForest> TMVAEvaluator::mGBRForest

private

Definition at line 45 of file TMVAEvaluator.h.

Referenced by evaluateGBRForest(), initialize(), and initializeGBRForest().

mIsInitialized

bool TMVAEvaluator::mIsInitialized

private

Definition at line 38 of file TMVAEvaluator.h.

Referenced by evaluate(), initialize(), and initializeGBRForest().

mMethod

std::string TMVAEvaluator::mMethod

private

Definition at line 42 of file TMVAEvaluator.h.

Referenced by evaluateTMVA(), and initialize().

mReader

std::unique_ptr<TMVA::Reader> TMVAEvaluator::mReader

private

Definition at line 44 of file TMVAEvaluator.h.

Referenced by evaluateTMVA(), and initialize().

mSpectators

std::map<std::string, std::pair<size_t, float> > TMVAEvaluator::mSpectators

mutableprivate

Definition at line 48 of file TMVAEvaluator.h.

Referenced by evaluate(), evaluateTMVA(), initialize(), and initializeGBRForest().

mUseAdaBoost

bool TMVAEvaluator::mUseAdaBoost

private

Definition at line 40 of file TMVAEvaluator.h.

Referenced by evaluateGBRForest(), initialize(), and initializeGBRForest().

mUsingGBRForest

bool TMVAEvaluator::mUsingGBRForest

private

Definition at line 39 of file TMVAEvaluator.h.

Referenced by evaluate(), initialize(), and initializeGBRForest().

mVariables

std::map<std::string, std::pair<size_t, float> > TMVAEvaluator::mVariables

mutableprivate

Definition at line 47 of file TMVAEvaluator.h.

Referenced by evaluate(), evaluateGBRForest(), evaluateTMVA(), initialize(), and initializeGBRForest().