Slice features class. More...

Public Member Functions
	SliceFeatures (const pandora::PfoList &nuPfos, const pandora::PfoList &crPfos, const SliceFeatureParameters &sliceFeatureParameters)
	Constructor. More...

	SliceFeatures (const SliceFeatures &rhs)=default
	Copy constructor. More...

SliceFeatures &	operator= (const SliceFeatures &rhs)=default
	Assignment operator. More...

	~SliceFeatures ()=default
	Destructor. More...

bool	IsFeatureVectorAvailable () const
	Check if all features were calculable. More...

void	FillFeatureVector (LArMvaHelper::MvaFeatureVector &featureVector) const
	Get the feature vector for the SVM. More...

float	GetAdaBoostDecisionTreeScore (const AdaBoostDecisionTree &adaBoostDecisionTree) const
	Get the probability that this slice contains a beam particle. More...

Private Member Functions
void	GetLeadingCaloHits (const pandora::CaloHitList &inputCaloHitList, pandora::CaloHitList &outputCaloHitList, double &closestHitToFaceDistance) const
	Select a given fraction of a slice's calo hits that are closest to the beam spot. More...

void	GetLArTPCIntercepts (const pandora::CartesianVector &a0, const pandora::CartesianVector &majorAxis, pandora::CartesianVector &interceptOne, pandora::CartesianVector &interceptTwo) const
	Find the intercepts of a line with the protoDUNE detector. More...

bool	IsContained (const pandora::CartesianVector &spacePoint, const float limit) const
	Check if a given 3D spacepoint is inside the global LArTPC volume. More...

Private Attributes
bool	m_isAvailable
	Is the feature vector available. More...

const SliceFeatureParameters	m_sliceFeatureParameters
	Geometry information block. More...

LArMvaHelper::MvaFeatureVector	m_featureVector
	The MVA feature vector. More...

Detailed Description

Slice features class.

Definition at line 219 of file BdtBeamParticleIdTool.h.

Constructor & Destructor Documentation

lar_content::BdtBeamParticleIdTool::SliceFeatures::SliceFeatures	(	const pandora::PfoList &	nuPfos,
		const pandora::PfoList &	crPfos,
		const SliceFeatureParameters &	sliceFeatureParameters
	)

Constructor.

Parameters

nuPfos	input list of Pfos reconstructed under the neutrino hypothesis
crPfos	input list of Pfos reconstructed under the cosmic ray hypothesis
geometryInfo	geometry information block

Referenced by lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::Initialize().

lar_content::BdtBeamParticleIdTool::SliceFeatures::SliceFeatures ( const SliceFeatures & rhs )

default

Copy constructor.

Parameters

rhs	the SliceFeatures to copy

lar_content::BdtBeamParticleIdTool::SliceFeatures::~SliceFeatures ( )

default

Destructor.

Member Function Documentation

void lar_content::BdtBeamParticleIdTool::SliceFeatures::FillFeatureVector ( LArMvaHelper::MvaFeatureVector & featureVector ) const

Get the feature vector for the SVM.

Parameters

featuresVector empty feature vector to populate

Definition at line 632 of file BdtBeamParticleIdTool.cc.

Referenced by lar_content::BdtBeamParticleIdTool::SelectOutputPfos().

 {
     if (!m_isAvailable)
         throw StatusCodeException(STATUS_CODE_NOT_FOUND);
 
     if (!featureVector.empty())
     {
         std::cout << "BdtBeamParticleIdTool::SliceFeatures::FillFeatureVector - feature vector already populated" << std::endl;
         throw StatusCodeException(STATUS_CODE_NOT_ALLOWED);
     }
 
     featureVector.insert(featureVector.end(), m_featureVector.begin(), m_featureVector.end());
 }

float lar_content::BdtBeamParticleIdTool::SliceFeatures::GetAdaBoostDecisionTreeScore ( const AdaBoostDecisionTree & adaBoostDecisionTree ) const

Get the probability that this slice contains a beam particle.

Parameters

adaBoostDecisionTree the adaptive boost decision tree used to calculate the probability

Returns: the probability that the slice contains a beam particle

Definition at line 648 of file BdtBeamParticleIdTool.cc.

References lar_content::LArMvaHelper::CalculateClassificationScore().

 {
     // ATTN if one or more of the features can not be calculated, then default to calling the slice a cosmic ray.  -1.f is the minimum score 
     // possible for a weighted bdt.
     if (!this->IsFeatureVectorAvailable()) return -1.f;
 
     LArMvaHelper::MvaFeatureVector featureVector;
 
     try
     {
         this->FillFeatureVector(featureVector);
     }
     catch (const StatusCodeException &statusCodeException)
     {
         std::cout << "BdtBeamParticleIdTool::SliceFeatures::GetAdaBoostDecisionTreeScore - unable to fill feature vector" << std::endl;
         return -1.f;
     }
 
     return LArMvaHelper::CalculateClassificationScore(adaBoostDecisionTree, featureVector);
 }

void lar_content::BdtBeamParticleIdTool::SliceFeatures::GetLArTPCIntercepts	(	const pandora::CartesianVector &	a0,
		const pandora::CartesianVector &	majorAxis,
		pandora::CartesianVector &	interceptOne,
		pandora::CartesianVector &	interceptTwo
	)		const

private

Find the intercepts of a line with the protoDUNE detector.

Parameters

a0	a point on the line in question
majorAxis	the direction of the line in question
interceptOne	to receive the first intersection between line and protoDUNE detector
interceptTwo	to receive the second intersection between line and protoDUNE detector

Definition at line 556 of file BdtBeamParticleIdTool.cc.

References f, lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::GetContainmentLimit(), lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::GetPlanes(), and lar_content::BdtBeamParticleIdTool::m_sliceFeatureParameters.

 {
     CartesianPointVector intercepts;
     CartesianVector lineUnitVector(0.f, 0.f, 0.f);
 
     try
     {
         lineUnitVector = lineDirection.GetUnitVector();
     }
     catch (const StatusCodeException &statusCodeException)
     {
         std::cout << "BdtBeamParticleIdTool::SliceFeatures::GetLArTPCIntercepts - normal vector to plane has a magnitude of zero" << std::endl;
         throw statusCodeException;
     }
 
     for (const Plane &plane : m_sliceFeatureParameters.GetPlanes())
     {
         const CartesianVector intercept(plane.GetLineIntersection(a0, lineUnitVector));
 
         if (this->IsContained(intercept, m_sliceFeatureParameters.GetContainmentLimit()))
             intercepts.push_back(intercept);
     }
 
     if (intercepts.size() > 1)
     {
         float maximumSeparationSquared(0.f);
         bool interceptsSet(false);
 
         for (unsigned int i = 0; i < intercepts.size(); i++)
         {
             for (unsigned int j = i + 1; j < intercepts.size(); j++)
             {
                 const CartesianVector &candidateInterceptOne(intercepts.at(i));
                 const CartesianVector &candidateInterceptTwo(intercepts.at(j));
                 const float separationSquared((candidateInterceptOne - candidateInterceptTwo).GetMagnitudeSquared());
 
                 if (separationSquared > maximumSeparationSquared)
                 {
                     maximumSeparationSquared = separationSquared;
                     interceptOne = candidateInterceptOne;
                     interceptTwo = candidateInterceptTwo;
                     interceptsSet = true;
                 }
             }
         }
 
         if (!interceptsSet)
         {
             std::cout << "BdtBeamParticleIdTool::SliceFeatures::GetLArTPCIntercepts - unable to set the intercepts between a line and the LArTPC" << std::endl;
             throw StatusCodeException(STATUS_CODE_NOT_ALLOWED);
         }
     }
     else
     {
         std::cout << "BdtBeamParticleIdTool::SliceFeatures::GetLArTPCIntercepts - inconsistent number of intercepts between a line and the LArTPC" << std::endl;
         throw StatusCodeException(STATUS_CODE_NOT_ALLOWED);
     }
 }

void lar_content::BdtBeamParticleIdTool::SliceFeatures::GetLeadingCaloHits	(	const pandora::CaloHitList &	inputCaloHitList,
		pandora::CaloHitList &	outputCaloHitList,
		double &	closestHitToFaceDistance
	)		const

private

Select a given fraction of a slice's calo hits that are closest to the beam spot.

Parameters

inputCaloHitList	all calo hits in slice
outputCaloHitList	to receive the list of selected calo hits
closestHitToFaceDistance	to receive the distance of closest hit to beam spot

Definition at line 515 of file BdtBeamParticleIdTool.cc.

References lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::GetBeamLArTPCIntersection(), lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::GetNSelectedHits(), lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::GetSelectedFraction(), and lar_content::BdtBeamParticleIdTool::m_sliceFeatureParameters.

 {
     if (inputCaloHitList.empty())
     {
         std::cout << "BdtBeamParticleIdTool::SliceFeatures::GetLeadingCaloHits - empty calo hit list" << std::endl;
         throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);
     }
 
     typedef std::pair<const CaloHit*, float> HitDistancePair;
     typedef std::vector<HitDistancePair> HitDistanceVector;
     HitDistanceVector hitDistanceVector;
 
     for (const CaloHit *const pCaloHit : inputCaloHitList)
         hitDistanceVector.emplace_back(pCaloHit, (pCaloHit->GetPositionVector() - m_sliceFeatureParameters.GetBeamLArTPCIntersection()).GetMagnitudeSquared());
 
     std::sort(hitDistanceVector.begin(), hitDistanceVector.end(), [](const HitDistancePair &lhs, const HitDistancePair &rhs) -> bool {return (lhs.second < rhs.second);});
 
     if (hitDistanceVector.front().second < 0.f)
     {
         std::cout << "BdtBeamParticleIdTool::SliceFeatures::GetLeadingCaloHits - unphysical magnitude of a vector" << std::endl;
         throw StatusCodeException(STATUS_CODE_NOT_ALLOWED);
     }
 
     closestHitToFaceDistance = std::sqrt(hitDistanceVector.front().second);
 
     const unsigned int nInputHits(inputCaloHitList.size());
     const unsigned int nSelectedCaloHits(nInputHits < m_sliceFeatureParameters.GetNSelectedHits() ? nInputHits :
         static_cast<unsigned int>(std::ceil(static_cast<float>(nInputHits) * m_sliceFeatureParameters.GetSelectedFraction() / 100.f)));
 
     for (const HitDistancePair &hitDistancePair : hitDistanceVector)
     {
         outputCaloHitList.push_back(hitDistancePair.first);
 
         if (outputCaloHitList.size() >= nSelectedCaloHits)
             break;
     }
 }

bool lar_content::BdtBeamParticleIdTool::SliceFeatures::IsContained	(	const pandora::CartesianVector &	spacePoint,
		const float	limit
	)		const

private

Check if a given 3D spacepoint is inside the global LArTPC volume.

Parameters

spacePoint

Definition at line 618 of file BdtBeamParticleIdTool.cc.

References lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::GetLArTPCMaxX(), lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::GetLArTPCMaxY(), lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::GetLArTPCMaxZ(), lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::GetLArTPCMinX(), lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::GetLArTPCMinY(), lar_content::BdtBeamParticleIdTool::SliceFeatureParameters::GetLArTPCMinZ(), and lar_content::BdtBeamParticleIdTool::m_sliceFeatureParameters.

 {
     if ((m_sliceFeatureParameters.GetLArTPCMinX() - spacePoint.GetX() > limit) || (spacePoint.GetX() - m_sliceFeatureParameters.GetLArTPCMaxX() > limit) ||
         (m_sliceFeatureParameters.GetLArTPCMinY() - spacePoint.GetY() > limit) || (spacePoint.GetY() - m_sliceFeatureParameters.GetLArTPCMaxY() > limit) ||
         (m_sliceFeatureParameters.GetLArTPCMinZ() - spacePoint.GetZ() > limit) || (spacePoint.GetZ() - m_sliceFeatureParameters.GetLArTPCMaxZ() > limit))
     {
         return false;
     }
 
     return true;
 }

bool lar_content::BdtBeamParticleIdTool::SliceFeatures::IsFeatureVectorAvailable ( ) const

inline

Check if all features were calculable.

Returns: true if the feature vector is available

Definition at line 526 of file BdtBeamParticleIdTool.h.

 {
     return m_isAvailable;
 }

SliceFeatures& lar_content::BdtBeamParticleIdTool::SliceFeatures::operator= ( const SliceFeatures & rhs )

default

Assignment operator.

Parameters

rhs	the SliceFeatures to assign

Member Data Documentation

LArMvaHelper::MvaFeatureVector lar_content::BdtBeamParticleIdTool::SliceFeatures::m_featureVector

private

The MVA feature vector.

Definition at line 304 of file BdtBeamParticleIdTool.h.

bool lar_content::BdtBeamParticleIdTool::SliceFeatures::m_isAvailable

private

Is the feature vector available.

Definition at line 302 of file BdtBeamParticleIdTool.h.

const SliceFeatureParameters lar_content::BdtBeamParticleIdTool::SliceFeatures::m_sliceFeatureParameters

private

Geometry information block.

Definition at line 303 of file BdtBeamParticleIdTool.h.

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArControlFlow/BdtBeamParticleIdTool.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArControlFlow/BdtBeamParticleIdTool.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation