LArMvaHelper class. More...

#include "LArMvaHelper.h"

Public Types
typedef MvaTypes::MvaFeature	MvaFeature

typedef MvaTypes::MvaFeatureVector	MvaFeatureVector

Static Public Member Functions
template<typename... TLISTS>
static pandora::StatusCode	ProduceTrainingExample (const std::string &trainingOutputFile, const bool result, TLISTS &&...featureLists)
	Produce a training example with the given features and result. More...

template<typename... TLISTS>
static bool	Classify (const MvaInterface &classifier, TLISTS &&...featureLists)
	Use the trained classifier to predict the boolean class of an example. More...

template<typename... TLISTS>
static double	CalculateClassificationScore (const MvaInterface &classifier, TLISTS &&...featureLists)
	Use the trained classifer to calculate the classification score of an example (>0 means boolean class true) More...

template<typename... TLISTS>
static double	CalculateProbability (const MvaInterface &classifier, TLISTS &&...featureLists)
	Use the trained mva to calculate a classification probability for an example. More...

template<typename... Ts, typename... TARGS>
static MvaFeatureVector	CalculateFeatures (const MvaFeatureToolVector< Ts... > &featureToolVector, TARGS &&...args)
	Calculate the features in a given feature tool vector. More...

template<typename T , typename... Ts, typename... TARGS>
static MvaFeatureVector	CalculateFeaturesOfType (const MvaFeatureToolVector< Ts... > &featureToolVector, TARGS &&...args)
	Calculate the features of a given derived feature tool type in a feature tool vector. More...

template<typename... Ts>
static pandora::StatusCode	AddFeatureToolToVector (pandora::AlgorithmTool *const pFeatureTool, MvaFeatureToolVector< Ts... > &featureToolVector)
	Add a feature tool to a vector of feature tools. More...

Static Private Member Functions
static std::string	GetTimestampString ()
	Get a timestamp string for this point in time. More...

template<typename TLIST , typename... TLISTS>
static pandora::StatusCode	WriteFeaturesToFile (std::ofstream &outfile, const std::string &delimiter, TLIST &&featureList, TLISTS &&...featureLists)
	Recursively write the features of the given lists to file. More...

static pandora::StatusCode	WriteFeaturesToFile (std::ofstream &, const std::string &)
	Recursively write the features of the given lists to file (terminating method) More...

template<typename TLIST >
static pandora::StatusCode	WriteFeaturesToFileImpl (std::ofstream &outfile, const std::string &delimiter, TLIST &&featureList)
	Write the features of the given list to file (implementation method) More...

template<typename TLIST , typename... TLISTS>
static MvaFeatureVector	ConcatenateFeatureLists (TLIST &&featureList, TLISTS &&...featureLists)
	Recursively concatenate vectors of features. More...

static MvaFeatureVector	ConcatenateFeatureLists ()
	Recursively concatenate vectors of features (terminating method) More...

Detailed Description

LArMvaHelper class.

Definition at line 54 of file LArMvaHelper.h.

Member Typedef Documentation

typedef MvaTypes::MvaFeature lar_content::LArMvaHelper::MvaFeature

Definition at line 57 of file LArMvaHelper.h.

typedef MvaTypes::MvaFeatureVector lar_content::LArMvaHelper::MvaFeatureVector

Definition at line 58 of file LArMvaHelper.h.

Member Function Documentation

template<typename... Ts>

pandora::StatusCode lar_content::LArMvaHelper::AddFeatureToolToVector	(	pandora::AlgorithmTool *const	pFeatureTool,
		MvaFeatureToolVector< Ts... > &	featureToolVector
	)

static

Add a feature tool to a vector of feature tools.

Parameters

pFeatureTool	the feature tool
featureToolVector	the vector to append

Returns: success

Definition at line 274 of file LArMvaHelper.h.

Referenced by lar_content::SvmPfoCharacterisationAlgorithm::ReadSettings(), lar_content::EnergyKickVertexSelectionAlgorithm::ReadSettings(), and lar_content::SvmVertexSelectionAlgorithm::ReadSettings().

 {
     if (MvaFeatureTool<Ts...> *const pCastFeatureTool = dynamic_cast<MvaFeatureTool<Ts...> *const>(pFeatureTool))
     {
         featureToolVector.push_back(pCastFeatureTool);
         return pandora::STATUS_CODE_SUCCESS;
     }
 
     return pandora::STATUS_CODE_FAILURE;
 }

template<typename... TLISTS>

double lar_content::LArMvaHelper::CalculateClassificationScore	(	const MvaInterface &	classifier,
		TLISTS &&...	featureLists
	)

static

Use the trained classifer to calculate the classification score of an example (>0 means boolean class true)

Parameters

classifier	the classifier
featureLists	the lists of features

Returns: the classification score

Definition at line 228 of file LArMvaHelper.h.

References lar_content::MvaInterface::CalculateClassificationScore().

Referenced by lar_content::BdtBeamParticleIdTool::SliceFeatures::GetAdaBoostDecisionTreeScore().

 {
     return classifier.CalculateClassificationScore(ConcatenateFeatureLists(std::forward<TLISTS>(featureLists)...));
 }

template<typename... Ts, typename... TARGS>

LArMvaHelper::MvaFeatureVector lar_content::LArMvaHelper::CalculateFeatures	(	const MvaFeatureToolVector< Ts... > &	featureToolVector,
		TARGS &&...	args
	)

static

Calculate the features in a given feature tool vector.

Parameters

featureToolVector	the feature tool vector
args	arguments to pass to the tool

Returns: the vector of features

Definition at line 244 of file LArMvaHelper.h.

Referenced by lar_content::SvmPfoCharacterisationAlgorithm::IsClearTrack(), and lar_content::SvmPfoCharacterisationAlgorithm::SvmPfoCharacterisationAlgorithm().

 {
     LArMvaHelper::MvaFeatureVector featureVector;
 
     for (MvaFeatureTool<Ts...> *const pFeatureTool : featureToolVector)
         pFeatureTool->Run(featureVector, std::forward<TARGS>(args)...);
 
     return featureVector;
 }

template<typename T , typename... Ts, typename... TARGS>

LArMvaHelper::MvaFeatureVector lar_content::LArMvaHelper::CalculateFeaturesOfType	(	const MvaFeatureToolVector< Ts... > &	featureToolVector,
		TARGS &&...	args
	)

static

Calculate the features of a given derived feature tool type in a feature tool vector.

Parameters

featureToolVector	the feature tool vector
args	arguments to pass to the tool

Returns: the vector of features

Definition at line 257 of file LArMvaHelper.h.

 {
     using TD = typename std::decay<T>::type;
     LArMvaHelper::MvaFeatureVector featureVector;
 
     for (MvaFeatureTool<Ts...> *const pFeatureTool : featureToolVector)
     {
         if (TD *const pCastFeatureTool = dynamic_cast<TD *const>(pFeatureTool))
             pCastFeatureTool->Run(featureVector, std::forward<TARGS>(args)...);
     }
 
     return featureVector;
 }

template<typename... TLISTS>

double lar_content::LArMvaHelper::CalculateProbability	(	const MvaInterface &	classifier,
		TLISTS &&...	featureLists
	)

static

Use the trained mva to calculate a classification probability for an example.

Parameters

classifier	the classifier
featureLists	the lists of features

Returns: the classification probability

Definition at line 236 of file LArMvaHelper.h.

References lar_content::MvaInterface::CalculateProbability().

Referenced by lar_content::NeutrinoIdTool::SliceFeatures::GetNeutrinoProbability(), lar_content::SvmPfoCharacterisationAlgorithm::IsClearTrack(), and lar_content::SvmPfoCharacterisationAlgorithm::SvmPfoCharacterisationAlgorithm().

 {
     return classifier.CalculateProbability(ConcatenateFeatureLists(std::forward<TLISTS>(featureLists)...));
 }

template<typename... TLISTS>

bool lar_content::LArMvaHelper::Classify	(	const MvaInterface &	classifier,
		TLISTS &&...	featureLists
	)

static

Use the trained classifier to predict the boolean class of an example.

Parameters

classifier	the classifier
featureLists	the lists of features

Returns: the predicted boolean class of the example

Definition at line 220 of file LArMvaHelper.h.

References lar_content::MvaInterface::Classify().

Referenced by lar_content::SvmVertexSelectionAlgorithm::CompareVertices(), lar_content::SvmPfoCharacterisationAlgorithm::IsClearTrack(), and lar_content::SvmPfoCharacterisationAlgorithm::SvmPfoCharacterisationAlgorithm().

 {
     return classifier.Classify(ConcatenateFeatureLists(std::forward<TLISTS>(featureLists)...));
 }

template<typename TLIST , typename... TLISTS>

LArMvaHelper::MvaFeatureVector lar_content::LArMvaHelper::ConcatenateFeatureLists	(	TLIST &&	featureList,
		TLISTS &&...	featureLists
	)

staticprivate

Recursively concatenate vectors of features.

Parameters

featureList	a list of features
featureLists	optional further lists of features

Returns: the concatenated vector of features

Definition at line 338 of file LArMvaHelper.h.

References fhicl::detail::atom::value().

 {
     static_assert(std::is_same<typename std::decay<TLIST>::type, LArMvaHelper::MvaFeatureVector>::value,
         "LArMvaHelper: Could not concatenate feature lists because one or more lists was not a vector of MvaFeatures");
 
     LArMvaHelper::MvaFeatureVector featureVector;
 
     for (const MvaFeature feature : featureList)
         featureVector.push_back(feature);
 
     LArMvaHelper::MvaFeatureVector newFeatureVector = ConcatenateFeatureLists(std::forward<TLISTS>(featureLists)...);
     featureVector.insert(featureVector.end(), newFeatureVector.begin(), newFeatureVector.end());
 
     return featureVector;
 }

LArMvaHelper::MvaFeatureVector lar_content::LArMvaHelper::ConcatenateFeatureLists ( )

inlinestaticprivate

Recursively concatenate vectors of features (terminating method)

Definition at line 356 of file LArMvaHelper.h.

 {
     return LArMvaHelper::MvaFeatureVector();
 }

std::string lar_content::LArMvaHelper::GetTimestampString ( )

inlinestaticprivate

Get a timestamp string for this point in time.

Returns: a timestamp string

Definition at line 287 of file LArMvaHelper.h.

 {
     std::time_t timestampNow = std::chrono::system_clock::to_time_t(std::chrono::system_clock::now());
 
     struct tm *pTimeInfo(NULL);
     char buffer[80];
 
     pTimeInfo = localtime(&timestampNow);
     strftime(buffer, 80, "%x_%X", pTimeInfo);
 
     std::string timeString(buffer);
 
     if (!timeString.empty() && timeString.back() == '\n') // last char is always a newline
         timeString.pop_back();
 
     return timeString;
 }

template<typename... TLISTS>

pandora::StatusCode lar_content::LArMvaHelper::ProduceTrainingExample	(	const std::string &	trainingOutputFile,
		const bool	result,
		TLISTS &&...	featureLists
	)

static

Produce a training example with the given features and result.

Parameters

trainingOutputFile	the file to which to append the example
featureLists	the lists of features

Returns: success

Definition at line 197 of file LArMvaHelper.h.

Referenced by lar_content::SvmPfoCharacterisationAlgorithm::IsClearTrack(), lar_content::SvmVertexSelectionAlgorithm::ProduceTrainingExamples(), lar_content::NeutrinoIdTool::SelectOutputPfos(), lar_content::BdtBeamParticleIdTool::SelectOutputPfos(), and lar_content::SvmPfoCharacterisationAlgorithm::SvmPfoCharacterisationAlgorithm().

 {
     std::ofstream outfile;
     outfile.open(trainingOutputFile, std::ios_base::app); // always append to the output file
 
     if (!outfile.is_open())
     {
         std::cout << "LArMvaHelper: could not open file for training examples at " << trainingOutputFile << std::endl;
         return pandora::STATUS_CODE_FAILURE;
     }
 
     std::string delimiter(",");
     outfile << GetTimestampString() << delimiter;
 
     PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, WriteFeaturesToFile(outfile, delimiter, featureLists...));
     outfile << static_cast<int>(result) << '\n';
 
     return pandora::STATUS_CODE_SUCCESS;
 }

template<typename TLIST , typename... TLISTS>

pandora::StatusCode lar_content::LArMvaHelper::WriteFeaturesToFile	(	std::ofstream &	outfile,
		const std::string &	delimiter,
		TLIST &&	featureList,
		TLISTS &&...	featureLists
	)

inlinestaticprivate

Recursively write the features of the given lists to file.

Parameters

outfile	the std::ofstream object to use
delimiter	the delimiter string
featureList	a list of features to write
featureLists	optional further lists of features to write

Returns: success

Definition at line 308 of file LArMvaHelper.h.

References fhicl::detail::atom::value().

 {
     static_assert(std::is_same<typename std::decay<TLIST>::type, LArMvaHelper::MvaFeatureVector>::value,
         "LArMvaHelper: Could not write training set example because a passed parameter was not a vector of MvaFeatures");
 
     PANDORA_RETURN_RESULT_IF(pandora::STATUS_CODE_SUCCESS, !=, WriteFeaturesToFileImpl(outfile, delimiter, featureList));
     return WriteFeaturesToFile(outfile, delimiter, featureLists...);
 }

pandora::StatusCode lar_content::LArMvaHelper::WriteFeaturesToFile	(	std::ofstream &	,
		const std::string &
	)

inlinestaticprivate

Recursively write the features of the given lists to file (terminating method)

Returns: success

Definition at line 319 of file LArMvaHelper.h.

 {
     return pandora::STATUS_CODE_SUCCESS;
 }

template<typename TLIST >

pandora::StatusCode lar_content::LArMvaHelper::WriteFeaturesToFileImpl	(	std::ofstream &	outfile,
		const std::string &	delimiter,
		TLIST &&	featureList
	)

staticprivate

Write the features of the given list to file (implementation method)

Parameters

outfile	the std::ofstream object to use
delimiter	the delimiter string
featureList	a list of features to write

Returns: success

Definition at line 327 of file LArMvaHelper.h.

 {
     for (const MvaFeature feature : featureList)
         outfile << feature.Get() << delimiter;
 
     return pandora::STATUS_CODE_SUCCESS;
 }

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArHelpers/LArMvaHelper.h

Public Types

Static Public Member Functions

Static Private Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation