LArConnectionPathwayHelper class. More...

#include "LArConnectionPathwayHelper.h"

Classes
class	SortByDistanceToPoint
	SortByDistanceToPoint class. More...

Static Public Member Functions
static bool	FindShowerStarts3D (const pandora::Algorithm const pAlgorithm, const pandora::ParticleFlowObject const pShowerPfo, const ProtoShowerMatch &protoShowerMatch, const pandora::CartesianVector &nuVertexPosition, const float maxSeparationFromHit, const float maxProjectionSeparation, const float maxXSeparation, pandora::CartesianPointVector &showerStarts3D)
	Create 3D shower start position(s) from three input 2D positions. More...

static void	FindShowerStartFromPosition (const pandora::Algorithm *const pAlgorithm, const ProtoShower &protoShowerU, const ProtoShower &protoShowerV, const ProtoShower &protoShowerW, pandora::CartesianVector &showerStart3D)
	Create 3D shower start position from three input 2D positions, assuming consistency of position. More...

static bool	FindShowerStartFromDirection (const pandora::Algorithm *const pAlgorithm, const ProtoShower &protoShowerU, const ProtoShower &protoShowerV, const ProtoShower &protoShowerW, pandora::CartesianVector &uShowerStart3D, pandora::CartesianVector &vShowerStart3D, pandora::CartesianVector &wShowerStart3D)
	Create a 3D shower start position from each input 2D position, assuming consistency of initial direction. More...

static bool	FindShowerStartFromDirection (const pandora::Algorithm *const pAlgorithm, const ProtoShower &protoShower, const ProtoShower &protoShowerA, const ProtoShower &protoShowerB, pandora::CartesianVector &showerStart3D)
	Create a 3D shower start position from an input 2D position, assuming consistency of initial direction. More...

static bool	ProjectShowerStartByDirection (const ProtoShower &protoShower, const float x, pandora::CartesianVector &showerStart2D)
	Find a 2D shower start, from a drift coordinate by assuming consistency of initial direction. More...

static bool	FindShowerStartFromXProjection (const pandora::Algorithm *const pAlgorithm, const ProtoShower &protoShower, const ProtoShower &protoShower1, const ProtoShower &protoShower2, const float maxSeparation, const float maxXSeparation, pandora::CartesianVector &showerStart3D)
	Create a 3D shower start position from an input 2D position, assuming consistency of the drift coordinate. More...

static bool	FindClosestSpinePosition (const ProtoShower &protoShower, const pandora::CartesianVector &showerStart3D, const float maxXSeparation, pandora::CartesianVector &foundShowerStart)
	Find the 2D spine hit that is closest to the neutrino vertex and shares a drift coordinate with an input 3D position. More...

static bool	FindShowerStartFromXProjectionRelaxed (const pandora::Algorithm *const pAlgorithm, const ProtoShower &protoShower, const ProtoShower &protoShower1, const ProtoShower &protoShower2, const float maxSeparation, const float maxXSeparation, pandora::CartesianVector &showerStart3D)
	A relaxed approach to create a 3D shower start position from an input 2D position, assuming consistency of the drift coordinate. More...

static void	GetMinMiddleMax (const float value1, const float value2, const float value3, float &minValue, float &middleValue, float &maxValue)
	Determine the lowest, median and highest value from an input of three numbers. More...

Detailed Description

LArConnectionPathwayHelper class.

Definition at line 21 of file LArConnectionPathwayHelper.h.

Member Function Documentation

bool lar_content::LArConnectionPathwayHelper::FindClosestSpinePosition	(	const ProtoShower &	protoShower,
		const pandora::CartesianVector &	showerStart3D,
		const float	maxXSeparation,
		pandora::CartesianVector &	foundShowerStart
	)

static

Find the 2D spine hit that is closest to the neutrino vertex and shares a drift coordinate with an input 3D position.

Parameters

protoShower	the input ProtoShower in which to search
showerStart3D	the input 3D shower start position
maxXSeparation	the max. drift-coordinate separation between a 3D shower start and a matched 2D shower hit
foundShowerStart	the output matched 2D hit position

Returns: whether a 2D spine hit could be found

Definition at line 270 of file LArConnectionPathwayHelper.cc.

References f, lar_content::ProtoShower::GetConnectionPathway(), lar_content::ProtoShower::GetSpineHitList(), lar_content::ConnectionPathway::GetStartDirection(), and lar_content::ConnectionPathway::GetStartPosition().

 {
     bool found(false);
     float lowestL(std::numeric_limits<float>::max());
 
     for (const CaloHit *const pCaloHit : protoShower.GetSpineHitList())
     {
         if (std::fabs(pCaloHit->GetPositionVector().GetX() - showerStart3D.GetX()) > maxXSeparation)
             continue;
 
         const float lVertex(protoShower.GetConnectionPathway().GetStartDirection().GetDotProduct(
             pCaloHit->GetPositionVector() - protoShower.GetConnectionPathway().GetStartPosition()));
 
         if ((lVertex > 0.f) && (lVertex < lowestL))
         {
             lowestL = lVertex;
             foundShowerStart = pCaloHit->GetPositionVector();
             found = true;
         }
     }
 
     return found;
 }

static bool lar_content::LArConnectionPathwayHelper::FindShowerStartFromDirection	(	const pandora::Algorithm *const	pAlgorithm,
		const ProtoShower &	protoShowerU,
		const ProtoShower &	protoShowerV,
		const ProtoShower &	protoShowerW,
		pandora::CartesianVector &	uShowerStart3D,
		pandora::CartesianVector &	vShowerStart3D,
		pandora::CartesianVector &	wShowerStart3D
	)

static

Create a 3D shower start position from each input 2D position, assuming consistency of initial direction.

Parameters

pAlgorithm	the calling algorithm
protoShowerU	the U view ProtoShower
protoShowerV	the V view ProtoShower
protoShowerW	the W view ProtoShower
uShowerStart3D	the output 3D shower start created from the U view shower start position
vShowerStart3D	the output 3D shower start created from the V view shower start position
wShowerStart3D	the output 3D shower start created from the W view shower start position

Returns: whether the 3D shower start positions could be created

static bool lar_content::LArConnectionPathwayHelper::FindShowerStartFromDirection	(	const pandora::Algorithm *const	pAlgorithm,
		const ProtoShower &	protoShower,
		const ProtoShower &	protoShowerA,
		const ProtoShower &	protoShowerB,
		pandora::CartesianVector &	showerStart3D
	)

static

Create a 3D shower start position from an input 2D position, assuming consistency of initial direction.

Parameters

pAlgorithm	the calling algorithm
protoShower	the input 2D position ProtoShower owner
protoShowerA	the ProtoShower of another view
protoShowerB	the ProtoShower in the remaining view
showerStart3D	the output 3D shower start

Returns: whether a 3D shower start position could be created

void lar_content::LArConnectionPathwayHelper::FindShowerStartFromPosition	(	const pandora::Algorithm *const	pAlgorithm,
		const ProtoShower &	protoShowerU,
		const ProtoShower &	protoShowerV,
		const ProtoShower &	protoShowerW,
		pandora::CartesianVector &	showerStart3D
	)

static

Create 3D shower start position from three input 2D positions, assuming consistency of position.

Parameters

pAlgorithm	the calling algorithm
protoShowerU	the U view ProtoShower
protoShowerV	the V view ProtoShower
protoShowerW	the W view ProtoShower
showerStart3D	the output 3D shower start position

Definition at line 148 of file LArConnectionPathwayHelper.cc.

References f, lar_content::ProtoShower::GetShowerCore(), lar_content::ProtoShower::GetSpineHitList(), lar_content::ShowerCore::GetStartPosition(), and x.

 {
     const CartesianVector showerStartU(protoShowerU.GetShowerCore().GetStartPosition());
     const CartesianVector showerStartV(protoShowerV.GetShowerCore().GetStartPosition());
     const CartesianVector showerStartW(protoShowerW.GetShowerCore().GetStartPosition());
 
     float chi2(0.0);
     LArGeometryHelper::MergeThreePositions3D(
         pAlgorithm->GetPandora(), TPC_VIEW_U, TPC_VIEW_V, TPC_VIEW_W, showerStartU, showerStartV, showerStartW, showerStart3D, chi2);
 }

bool lar_content::LArConnectionPathwayHelper::FindShowerStartFromXProjection	(	const pandora::Algorithm *const	pAlgorithm,
		const ProtoShower &	protoShower,
		const ProtoShower &	protoShower1,
		const ProtoShower &	protoShower2,
		const float	maxSeparation,
		const float	maxXSeparation,
		pandora::CartesianVector &	showerStart3D
	)

static

Create a 3D shower start position from an input 2D position, assuming consistency of the drift coordinate.

Parameters

pAlgorithm	the calling algorithm
protoShower	the ProtoShower from which the input 2D shower start is obtained
protoShower1	a matched ProtoShower from another view
protoShower2	the matched ProtoShower from the final view
maxSeparation	the max. separation between the projected 3D shower start and the shower start of that view
maxXSeparation	the max. drift-coordinate separation between a 3D shower start and a matched 2D shower hit
showerStart3D	the output 3D shower start

Returns: whether the 3D shower start positions could be created

Definition at line 228 of file LArConnectionPathwayHelper.cc.

References f, lar_content::ProtoShower::GetShowerCore(), lar_content::ProtoShower::GetSpineHitList(), and lar_content::ShowerCore::GetStartPosition().

 {
     const CartesianVector showerStart(protoShower.GetShowerCore().GetStartPosition());
     CartesianVector showerStart1(0.f, 0.f, 0.f), showerStart2(0.f, 0.f, 0.f);
 
     const HitType hitType(protoShower.GetSpineHitList().front()->GetHitType());
     const HitType hitType1(protoShower1.GetSpineHitList().front()->GetHitType());
     const HitType hitType2(protoShower2.GetSpineHitList().front()->GetHitType());
 
     if (!LArConnectionPathwayHelper::FindClosestSpinePosition(protoShower1, showerStart, maxXSeparation, showerStart1))
         return false;
 
     if (!LArConnectionPathwayHelper::FindClosestSpinePosition(protoShower2, showerStart, maxXSeparation, showerStart2))
         return false;
 
     float chi2(0.f);
     CartesianVector projection(0.f, 0.f, 0.f), projection1(0.f, 0.f, 0.f), projection2(0.f, 0.f, 0.f);
 
     LArGeometryHelper::MergeTwoPositions(pAlgorithm->GetPandora(), hitType1, hitType2, showerStart1, showerStart2, projection, chi2);
     const float separationSquared((projection - showerStart).GetMagnitudeSquared());
 
     LArGeometryHelper::MergeTwoPositions(pAlgorithm->GetPandora(), hitType, hitType2, showerStart, showerStart2, projection1, chi2);
     const float separationSquared1((projection1 - showerStart1).GetMagnitudeSquared());
 
     LArGeometryHelper::MergeTwoPositions(pAlgorithm->GetPandora(), hitType, hitType1, showerStart, showerStart1, projection2, chi2);
     const float separationSquared2((projection2 - showerStart2).GetMagnitudeSquared());
 
     if ((separationSquared > maxSeparation * maxSeparation) || (separationSquared1 > maxSeparation * maxSeparation) ||
         (separationSquared2 > maxSeparation * maxSeparation))
     {
         return false;
     }
 
     LArGeometryHelper::MergeThreePositions3D(
         pAlgorithm->GetPandora(), hitType, hitType1, hitType2, showerStart, showerStart1, showerStart2, showerStart3D, chi2);
 
     return true;
 }

bool lar_content::LArConnectionPathwayHelper::FindShowerStartFromXProjectionRelaxed	(	const pandora::Algorithm *const	pAlgorithm,
		const ProtoShower &	protoShower,
		const ProtoShower &	protoShower1,
		const ProtoShower &	protoShower2,
		const float	maxSeparation,
		const float	maxXSeparation,
		pandora::CartesianVector &	showerStart3D
	)

static

A relaxed approach to create a 3D shower start position from an input 2D position, assuming consistency of the drift coordinate.

Parameters

pAlgorithm	the calling algorithm
protoShower	the ProtoShower from which the input 2D shower start is obtained
protoShower1	a matched ProtoShower from another view
protoShower2	the matched ProtoShower from the final view
maxSeparation	the max. separation between the projected 3D shower start and the shower start of that view
maxXSeparation	the max. drift-coordinate separation between a 3D shower start and a matched 2D shower hit
ShowerStart3D	the output 3D shower start

Returns: whether the 3D shower start position could be created

Definition at line 297 of file LArConnectionPathwayHelper.cc.

References f, lar_content::ProtoShower::GetShowerCore(), lar_content::ProtoShower::GetSpineHitList(), and lar_content::ShowerCore::GetStartPosition().

 {
     const CartesianVector showerStart(protoShower.GetShowerCore().GetStartPosition());
     CartesianVector showerStart1(0.f, 0.f, 0.f);
 
     const HitType hitType(protoShower.GetSpineHitList().front()->GetHitType());
     const HitType hitType1(protoShower1.GetSpineHitList().front()->GetHitType());
 
     if (!LArConnectionPathwayHelper::FindClosestSpinePosition(protoShower1, showerStart, maxXSeparation, showerStart1))
         return false;
 
     float chi2(0.f);
     CartesianVector projection2(0.f, 0.f, 0.f);
 
     LArGeometryHelper::MergeTwoPositions(pAlgorithm->GetPandora(), hitType, hitType1, showerStart, showerStart1, projection2, chi2);
 
     // Now make sure that they agree...
     const CaloHitList &caloHitList2(protoShower2.GetSpineHitList());
     const float separation(LArClusterHelper::GetClosestDistance(projection2, caloHitList2));
 
     if (separation > maxSeparation)
         return false;
 
     LArGeometryHelper::MergeTwoPositions3D(pAlgorithm->GetPandora(), hitType, hitType1, showerStart, showerStart1, showerStart3D, chi2);
 
     return true;
 }

bool lar_content::LArConnectionPathwayHelper::FindShowerStarts3D	(	const pandora::Algorithm *const	pAlgorithm,
		const pandora::ParticleFlowObject *const	pShowerPfo,
		const ProtoShowerMatch &	protoShowerMatch,
		const pandora::CartesianVector &	nuVertexPosition,
		const float	maxSeparationFromHit,
		const float	maxProjectionSeparation,
		const float	maxXSeparation,
		pandora::CartesianPointVector &	showerStarts3D
	)

static

Create 3D shower start position(s) from three input 2D positions.

Parameters

pAlgorithm	the calling algorithm
pShowerPfo	the shower pfo
protoShowerMatch	the ProtoShowerMatch object
nuVertexPosition	the 3D neutrino vertex
maxSeparationFromHit	the max. separation between a projected 3D shower start and the closest 2D shower hit
maxProjectionSeparation	the max. separation between the projected 3D shower start and the shower start of that view
maxXSeparation	the max. drift-coordinate separation between a 3D shower start and a matched 2D shower hit
showerStarts3D	the output vector of 3D shower starts (ordered closest -> furthest from the neutrino vertex)

Returns: whether a consistent 3D shower start position could be created

Definition at line 45 of file LArConnectionPathwayHelper.cc.

References lar_content::DIRECTION, f, lar_content::ProtoShowerMatch::GetConsistencyType(), lar_content::ProtoShowerMatch::GetProtoShowerU(), lar_content::ProtoShowerMatch::GetProtoShowerV(), lar_content::ProtoShowerMatch::GetProtoShowerW(), lar_content::POSITION, and lar_content::X_PROJECTION.

Referenced by lar_content::ElectronInitialRegionRefinementAlgorithm::RefineShower().

 {
     const ProtoShower &protoShowerU(protoShowerMatch.GetProtoShowerU());
     const ProtoShower &protoShowerV(protoShowerMatch.GetProtoShowerV());
     const ProtoShower &protoShowerW(protoShowerMatch.GetProtoShowerW());
     const Consistency consistency(protoShowerMatch.GetConsistencyType());
 
     bool uFound(false), vFound(false), wFound(false);
     CartesianVector uShowerStart3D(0.f, 0.f, 0.f), vShowerStart3D(0.f, 0.f, 0.f), wShowerStart3D(0.f, 0.f, 0.f);
 
     CaloHitList caloHitList3D;
     LArPfoHelper::GetCaloHits(pShowerPfo, TPC_3D, caloHitList3D);
 
     if (consistency == Consistency::POSITION)
     {
         LArConnectionPathwayHelper::FindShowerStartFromPosition(pAlgorithm, protoShowerU, protoShowerV, protoShowerW, uShowerStart3D);
         vShowerStart3D = uShowerStart3D;
         wShowerStart3D = uShowerStart3D;
 
         if (LArClusterHelper::GetClosestDistance(uShowerStart3D, caloHitList3D) < maxSeparationFromHit)
         {
             uFound = true;
             vFound = true;
             wFound = true;
         }
     }
     else if (consistency == Consistency::DIRECTION)
     {
         if (LArConnectionPathwayHelper::FindShowerStartFromDirection(
                 pAlgorithm, protoShowerU, protoShowerV, protoShowerW, uShowerStart3D, vShowerStart3D, wShowerStart3D))
         {
             if (LArClusterHelper::GetClosestDistance(uShowerStart3D, caloHitList3D) < maxSeparationFromHit)
                 uFound = true;
 
             if (LArClusterHelper::GetClosestDistance(vShowerStart3D, caloHitList3D) < maxSeparationFromHit)
                 vFound = true;
 
             if (LArClusterHelper::GetClosestDistance(wShowerStart3D, caloHitList3D) < maxSeparationFromHit)
                 wFound = true;
         }
     }
 
     if (!uFound || (consistency == Consistency::X_PROJECTION))
     {
         if (LArConnectionPathwayHelper::FindShowerStartFromXProjection(
                 pAlgorithm, protoShowerU, protoShowerV, protoShowerW, maxProjectionSeparation, maxXSeparation, uShowerStart3D) ||
             LArConnectionPathwayHelper::FindShowerStartFromXProjectionRelaxed(
                 pAlgorithm, protoShowerU, protoShowerV, protoShowerW, maxProjectionSeparation, maxXSeparation, uShowerStart3D) ||
             LArConnectionPathwayHelper::FindShowerStartFromXProjectionRelaxed(
                 pAlgorithm, protoShowerU, protoShowerW, protoShowerV, maxProjectionSeparation, maxXSeparation, uShowerStart3D))
         {
             uFound = true;
         }
 
         if (LArConnectionPathwayHelper::FindShowerStartFromXProjection(
                 pAlgorithm, protoShowerV, protoShowerW, protoShowerU, maxProjectionSeparation, maxXSeparation, vShowerStart3D) ||
             LArConnectionPathwayHelper::FindShowerStartFromXProjectionRelaxed(
                 pAlgorithm, protoShowerV, protoShowerW, protoShowerU, maxProjectionSeparation, maxXSeparation, vShowerStart3D) ||
             LArConnectionPathwayHelper::FindShowerStartFromXProjectionRelaxed(
                 pAlgorithm, protoShowerV, protoShowerU, protoShowerW, maxProjectionSeparation, maxXSeparation, vShowerStart3D))
         {
             vFound = true;
         }
 
         if (LArConnectionPathwayHelper::FindShowerStartFromXProjection(
                 pAlgorithm, protoShowerW, protoShowerU, protoShowerV, maxProjectionSeparation, maxXSeparation, wShowerStart3D) ||
             LArConnectionPathwayHelper::FindShowerStartFromXProjectionRelaxed(
                 pAlgorithm, protoShowerW, protoShowerU, protoShowerV, maxProjectionSeparation, maxXSeparation, wShowerStart3D) ||
             LArConnectionPathwayHelper::FindShowerStartFromXProjectionRelaxed(
                 pAlgorithm, protoShowerW, protoShowerV, protoShowerU, maxProjectionSeparation, maxXSeparation, wShowerStart3D))
         {
             wFound = true;
         }
     }
 
     CartesianPointVector foundShowerStarts3D;
 
     if (uFound)
         foundShowerStarts3D.push_back(uShowerStart3D);
 
     if (vFound)
         foundShowerStarts3D.push_back(vShowerStart3D);
 
     if (wFound)
         foundShowerStarts3D.push_back(wShowerStart3D);
 
     if (foundShowerStarts3D.empty())
         return false;
 
     std::sort(foundShowerStarts3D.begin(), foundShowerStarts3D.end(), LArConnectionPathwayHelper::SortByDistanceToPoint(nuVertexPosition));
 
     // ATTN: We need there to be three
     showerStarts3D.push_back(foundShowerStarts3D.front());
     showerStarts3D.push_back((foundShowerStarts3D.size() == 3) ? foundShowerStarts3D[1] : foundShowerStarts3D[0]);
     showerStarts3D.push_back(foundShowerStarts3D.back());
 
     return true;
 }

void lar_content::LArConnectionPathwayHelper::GetMinMiddleMax	(	const float	value1,
		const float	value2,
		const float	value3,
		float &	minValue,
		float &	middleValue,
		float &	maxValue
	)

static

Determine the lowest, median and highest value from an input of three numbers.

Parameters

value1	the first value
value2	the second value
value3	the third value
minValue	the minimum value
middleValue	the median value
maxValue	the maximum value

Definition at line 330 of file LArConnectionPathwayHelper.cc.

References util::values().

Referenced by lar_content::ConnectionRegionFeatureTool::Get2DKink(), lar_content::InitialRegionFeatureTool::InitialRegionFeatureTool(), and lar_content::ShowerRegionFeatureTool::ShowerRegionFeatureTool().

 {
     FloatVector values({value1, value2, value3});
 
     std::sort(values.begin(), values.end());
 
     minValue = values.at(0);
     middleValue = values.at(1);
     maxValue = values.at(2);
 }

bool lar_content::LArConnectionPathwayHelper::ProjectShowerStartByDirection	(	const ProtoShower &	protoShower,
		const float	x,
		pandora::CartesianVector &	showerStart2D
	)

static

Find a 2D shower start, from a drift coordinate by assuming consistency of initial direction.

Parameters

protoShower	the ProtoShower for which to find the shower start
x	the drift-coordinate
showerStart2D	the output 2D shower start

Returns: whether a 2D shower start position could be found

Definition at line 207 of file LArConnectionPathwayHelper.cc.

References f, lar_content::ProtoShower::GetConnectionPathway(), lar_content::ProtoShower::GetShowerCore(), lar_content::ConnectionPathway::GetStartDirection(), lar_content::ShowerCore::GetStartPosition(), and lar_content::ConnectionPathway::GetStartPosition().

 {
     const CartesianVector &viewShowerStart(protoShower.GetShowerCore().GetStartPosition());
     const CartesianVector &viewNuVertex(protoShower.GetConnectionPathway().GetStartPosition());
     const CartesianVector &viewPeakDirection(protoShower.GetConnectionPathway().GetStartDirection());
     const CartesianVector &displacement(viewShowerStart - viewNuVertex);
     const float transverse(viewPeakDirection.GetCrossProduct(displacement).GetMagnitude());
 
     if (transverse > 1.f)
         return false;
 
     const CartesianVector xAxis(1.f, 0.f, 0.f);
     const float cosTheta(std::fabs(viewPeakDirection.GetCosOpeningAngle(xAxis)));
 
     showerStart2D = viewNuVertex + (viewPeakDirection * (std::fabs(x - viewNuVertex.GetX()) * cosTheta));
 
     return true;
 }

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArHelpers/LArConnectionPathwayHelper.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArHelpers/LArConnectionPathwayHelper.cc

Classes

Static Public Member Functions

Detailed Description

Member Function Documentation