#include "ShowerSpineFinderTool.h"

Inheritance diagram for lar_content::ShowerSpineFinderTool:

Public Member Functions
	ShowerSpineFinderTool ()

pandora::StatusCode	Run (const pandora::CartesianVector &nuVertex3D, const pandora::CaloHitList *const pViewHitList, const pandora::HitType hitType, const pandora::CartesianVector &peakDirection, pandora::CaloHitList &unavailableHitList, pandora::CaloHitList &showerSpineHitList)

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

void	FindShowerSpine (const pandora::CaloHitList *const pViewHitList, const pandora::CartesianVector &nuVertex2D, const pandora::CartesianVector &initialDirection, pandora::CaloHitList &unavailableHitList, pandora::CaloHitList &showerSpineHitList) const
	Perform a running fit to collect the hits of the shower spine. More...

bool	CollectSubsectionHits (const TwoDSlidingFitResult &extrapolatedFit, const pandora::CartesianVector &extrapolatedStartPosition, const pandora::CartesianVector &extrapolatedEndPosition, const pandora::CartesianVector &extrapolatedDirection, const bool isEndDownstream, const pandora::CaloHitList *const pViewHitList, pandora::CartesianPointVector &runningFitPositionVector, pandora::CaloHitList &unavailableHitList, pandora::CaloHitList &showerSpineHitList) const
	Perform a running fit step: collect hits which lie close to the shower spine projection. More...

bool	IsCloseToLine (const pandora::CartesianVector &hitPosition, const pandora::CartesianVector &lineStart, const pandora::CartesianVector &lineDirection, const float distanceToLine) const
	Determine whether a hit lies close to the shower spine projection. More...

void	CollectConnectedHits (const pandora::CaloHitList &collectedHits, const pandora::CartesianVector &extrapolatedStartPosition, const pandora::CartesianVector &extrapolatedDirection, pandora::CartesianPointVector &runningFitPositionVector, pandora::CaloHitList &showerSpineHitList) const
	Add to the shower spine the connecting hits. More...

float	GetClosestDistance (const pandora::CartesianVector &position, const pandora::CartesianPointVector &testPositions) const
	Find the smallest distance between a position and a list of other positions. More...

Private Attributes
unsigned int	m_hitThresholdForSpine
	The hit threshold for a significant spine. More...

float	m_growingFitInitialLength
	The first step distance. More...

float	m_initialFitDistanceToLine
	The max. proximity to the spine projection for collection in the first step. More...

unsigned int	m_minInitialHitsFound
	The min. number of hits collected in the first step for continuation. More...

unsigned int	m_maxFittingHits
	The number of hits to consider in the running fit. More...

unsigned int	m_localSlidingFitWindow
	The standard sliding fit window for spine fits. More...

float	m_growingFitSegmentLength
	The standard step distance. More...

unsigned int	m_highResolutionSlidingFitWindow
	The high resolution sliding fit window for spine fits. More...

float	m_distanceToLine
	The max. proximity to the spine projection for collection. More...

float	m_hitConnectionDistance
	The max. separation between connected hits. More...

Detailed Description

Definition at line 19 of file ShowerSpineFinderTool.h.

Constructor & Destructor Documentation

lar_content::ShowerSpineFinderTool::ShowerSpineFinderTool ( )

Definition at line 25 of file ShowerSpineFinderTool.cc.

                                              :
     m_hitThresholdForSpine(7),
     m_growingFitInitialLength(10.f),
     m_initialFitDistanceToLine(0.5f),
     m_minInitialHitsFound(7),
     m_maxFittingHits(15),
     m_localSlidingFitWindow(10),
     m_growingFitSegmentLength(5.f),
     m_highResolutionSlidingFitWindow(5),
     m_distanceToLine(0.75f),
     m_hitConnectionDistance(0.75f)
 {
 }

Member Function Documentation

void lar_content::ShowerSpineFinderTool::CollectConnectedHits	(	const pandora::CaloHitList &	collectedHits,
		const pandora::CartesianVector &	extrapolatedStartPosition,
		const pandora::CartesianVector &	extrapolatedDirection,
		pandora::CartesianPointVector &	runningFitPositionVector,
		pandora::CaloHitList &	showerSpineHitList
	)		const

private

Add to the shower spine the connecting hits.

Parameters

collectedHits	the input list of close hits
extrapolatedStartPosition	the shower spine projection start position
extrapolatedDirection	the shower spine projection direction
runningFitPositionVector	the vector of the collected hit positions
showerSpineHitList	the list of collected shower spine hits

Definition at line 228 of file ShowerSpineFinderTool.cc.

References GetClosestDistance(), lar_content::LArHitWidthHelper::GetClosestDistance(), lar_content::LArHitWidthHelper::GetClosestPointToLine2D(), and m_hitConnectionDistance.

Referenced by CollectSubsectionHits().

 {
     bool found(true);
 
     while (found)
     {
         found = false;
 
         for (const CaloHit *const pCaloHit : collectedHits)
         {
             if (std::find(showerSpineHitList.begin(), showerSpineHitList.end(), pCaloHit) != showerSpineHitList.end())
                 continue;
 
             CartesianVector hitPosition(pCaloHit->GetPositionVector());
 
             if (this->GetClosestDistance(hitPosition, runningFitPositionVector) > m_hitConnectionDistance)
             {
                 if (LArHitWidthHelper::GetClosestDistance(pCaloHit, showerSpineHitList) > m_hitConnectionDistance)
                     continue;
 
                 hitPosition = LArHitWidthHelper::GetClosestPointToLine2D(extrapolatedStartPosition, extrapolatedDirection, pCaloHit);
             }
 
             found = true;
 
             runningFitPositionVector.push_back(hitPosition);
             showerSpineHitList.push_back(pCaloHit);
         }
     }
 }

bool lar_content::ShowerSpineFinderTool::CollectSubsectionHits	(	const TwoDSlidingFitResult &	extrapolatedFit,
		const pandora::CartesianVector &	extrapolatedStartPosition,
		const pandora::CartesianVector &	extrapolatedEndPosition,
		const pandora::CartesianVector &	extrapolatedDirection,
		const bool	isEndDownstream,
		const pandora::CaloHitList *const	pViewHitList,
		pandora::CartesianPointVector &	runningFitPositionVector,
		pandora::CaloHitList &	unavailableHitList,
		pandora::CaloHitList &	showerSpineHitList
	)		const

private

Perform a running fit step: collect hits which lie close to the shower spine projection.

Parameters

extrapolatedFit	the fit to the hitherto collected hits
extrapolatedStartPosition	the shower spine projection start position
extrapolatedEndPosition	the shower spine projection end position
extrapolatedDirection	the shower spine projection direction
isEndDownstream	whether the shower direction is downstream (in Z) of the neutrino vertex
pViewHitList	the 2D event hit list
runningFitPositionVector	the vector of the hitherto collected hit positions
unavailableHitList	protected hits that cannot be collected
showerSpineHitList	the output list of shower spine hits

Returns: whether any hits were collected in the running fit step

Definition at line 155 of file ShowerSpineFinderTool.cc.

References CollectConnectedHits(), f, lar_content::LArHitWidthHelper::GetClosestPointToLine2D(), lar_content::TwoDSlidingFitResult::GetLocalPosition(), IsCloseToLine(), and m_distanceToLine.

Referenced by FindShowerSpine().

 {
     float extrapolatedStartL(0.f), extrapolatedStartT(0.f);
     extrapolatedFit.GetLocalPosition(extrapolatedStartPosition, extrapolatedStartL, extrapolatedStartT);
 
     float extrapolatedEndL(0.f), extrapolatedEndT(0.f);
     extrapolatedFit.GetLocalPosition(extrapolatedEndPosition, extrapolatedEndL, extrapolatedEndT);
 
     CaloHitList collectedHits;
 
     for (const CaloHit *const pCaloHit : *pViewHitList)
     {
         if (std::find(showerSpineHitList.begin(), showerSpineHitList.end(), pCaloHit) != showerSpineHitList.end())
             continue;
 
         if (std::find(unavailableHitList.begin(), unavailableHitList.end(), pCaloHit) != unavailableHitList.end())
             continue;
 
         const CartesianVector &hitPosition(pCaloHit->GetPositionVector());
 
         float hitL(0.f), hitT(0.f);
         extrapolatedFit.GetLocalPosition(hitPosition, hitL, hitT);
 
         // Assess whether hit is within section boundaries
         if (isEndDownstream && ((hitL < extrapolatedStartL) || (hitL > extrapolatedEndL)))
             continue;
 
         if (!isEndDownstream && ((hitL > extrapolatedStartL) || (hitL < extrapolatedEndL)))
             continue;
 
         // Assess whether hit is close to connecting line - taking account hit width if necessary
         if (this->IsCloseToLine(hitPosition, extrapolatedStartPosition, extrapolatedDirection, m_distanceToLine))
         {
             collectedHits.push_back(pCaloHit);
         }
         else
         {
             const CartesianVector closestPointInHit(
                 LArHitWidthHelper::GetClosestPointToLine2D(extrapolatedStartPosition, extrapolatedDirection, pCaloHit));
 
             if (this->IsCloseToLine(closestPointInHit, extrapolatedStartPosition, extrapolatedDirection, m_distanceToLine))
                 collectedHits.push_back(pCaloHit);
         }
     }
 
     const int nInitialHits(showerSpineHitList.size());
 
     // Now find a continuous path of collected hits
     this->CollectConnectedHits(collectedHits, extrapolatedStartPosition, extrapolatedDirection, runningFitPositionVector, showerSpineHitList);
 
     const int nFinalHits(showerSpineHitList.size());
 
     return (nFinalHits != nInitialHits);
 }

void lar_content::ShowerSpineFinderTool::FindShowerSpine	(	const pandora::CaloHitList *const	pViewHitList,
		const pandora::CartesianVector &	nuVertex2D,
		const pandora::CartesianVector &	initialDirection,
		pandora::CaloHitList &	unavailableHitList,
		pandora::CaloHitList &	showerSpineHitList
	)		const

private

Perform a running fit to collect the hits of the shower spine.

Parameters

pViewHitList	the 2D event hit list
nuVertex2D	the 2D neutrino vertex
initialDirection	the initial direction of the pathway
unavailableHitList	protected hits that cannot be collected
showerSpineHitList	the output list of shower spine hits

Definition at line 57 of file ShowerSpineFinderTool.cc.

References CollectSubsectionHits(), f, lar_content::TwoDSlidingFitResult::GetGlobalMaxLayerDirection(), lar_content::TwoDSlidingFitResult::GetGlobalMaxLayerPosition(), lar_content::TwoDSlidingFitResult::GetGlobalMinLayerDirection(), lar_content::TwoDSlidingFitResult::GetGlobalMinLayerPosition(), lar_content::LArGeometryHelper::GetWirePitch(), m_growingFitInitialLength, m_growingFitSegmentLength, m_highResolutionSlidingFitWindow, m_initialFitDistanceToLine, m_localSlidingFitWindow, m_maxFittingHits, and m_minInitialHitsFound.

Referenced by Run().

 {
     // Use initial direction to find seed hits for a starting fit
     float highestL(0.f);
     CartesianPointVector runningFitPositionVector;
 
     for (const CaloHit *const pCaloHit : *pViewHitList)
     {
         const CartesianVector &hitPosition(pCaloHit->GetPositionVector());
         const CartesianVector &displacementVector(hitPosition - nuVertex2D);
         const float l(initialDirection.GetDotProduct(displacementVector));
         const float t(initialDirection.GetCrossProduct(displacementVector).GetMagnitude());
 
         if ((l < m_growingFitInitialLength) && (l > 0.f) && (t < m_initialFitDistanceToLine))
         {
             if (l > highestL)
                 highestL = l;
 
             if (std::find(unavailableHitList.begin(), unavailableHitList.end(), pCaloHit) == unavailableHitList.end())
             {
                 showerSpineHitList.push_back(pCaloHit);
             }
 
             runningFitPositionVector.push_back(hitPosition);
         }
     }
 
     // Require significant number of initial hits
     if (runningFitPositionVector.size() < m_minInitialHitsFound)
     {
         showerSpineHitList.clear();
         return;
     }
 
     // Perform a running fit to collect a pathway of hits
     unsigned int count(0);
     bool hitsCollected(true);
     const bool isEndDownstream(initialDirection.GetZ() > 0.f);
     const float slidingFitPitch(LArGeometryHelper::GetWirePitch(this->GetPandora(), showerSpineHitList.front()->GetHitType()));
     CartesianVector extrapolatedStartPosition(nuVertex2D), extrapolatedDirection(initialDirection);
     CartesianVector extrapolatedEndPosition(extrapolatedStartPosition + (extrapolatedDirection * highestL));
 
     while (hitsCollected)
     {
         ++count;
 
         try
         {
             const int excessHitsInFit(runningFitPositionVector.size() - m_maxFittingHits);
 
             if (excessHitsInFit > 0)
             {
                 // Remove furthest away hits
                 std::sort(runningFitPositionVector.begin(), runningFitPositionVector.end(),
                     LArConnectionPathwayHelper::SortByDistanceToPoint(extrapolatedEndPosition));
 
                 for (int i = 0; i < excessHitsInFit; ++i)
                     runningFitPositionVector.erase(std::prev(runningFitPositionVector.end()));
             }
 
             const TwoDSlidingFitResult extrapolatedFit(&runningFitPositionVector, m_localSlidingFitWindow, slidingFitPitch);
 
             extrapolatedStartPosition = count == 1 ? extrapolatedEndPosition
                 : isEndDownstream                  ? extrapolatedFit.GetGlobalMaxLayerPosition()
                                                    : extrapolatedFit.GetGlobalMinLayerPosition();
             extrapolatedDirection =
                 isEndDownstream ? extrapolatedFit.GetGlobalMaxLayerDirection() : extrapolatedFit.GetGlobalMinLayerDirection() * (-1.f);
             extrapolatedEndPosition = extrapolatedStartPosition + (extrapolatedDirection * m_growingFitSegmentLength);
 
             hitsCollected = this->CollectSubsectionHits(extrapolatedFit, extrapolatedStartPosition, extrapolatedEndPosition,
                 extrapolatedDirection, isEndDownstream, pViewHitList, runningFitPositionVector, unavailableHitList, showerSpineHitList);
 
             // If no hits found, as a final effort, reduce the sliding fit window
             if (!hitsCollected)
             {
                 const TwoDSlidingFitResult microExtrapolatedFit(&runningFitPositionVector, m_highResolutionSlidingFitWindow, slidingFitPitch);
 
                 extrapolatedStartPosition = count == 1 ? extrapolatedStartPosition
                     : isEndDownstream                  ? microExtrapolatedFit.GetGlobalMaxLayerPosition()
                                                        : microExtrapolatedFit.GetGlobalMinLayerPosition();
                 extrapolatedDirection = isEndDownstream ? microExtrapolatedFit.GetGlobalMaxLayerDirection()
                                                         : microExtrapolatedFit.GetGlobalMinLayerDirection() * (-1.f);
                 extrapolatedEndPosition = extrapolatedStartPosition + (extrapolatedDirection * m_growingFitSegmentLength);
 
                 hitsCollected = this->CollectSubsectionHits(microExtrapolatedFit, extrapolatedStartPosition, extrapolatedEndPosition,
                     extrapolatedDirection, isEndDownstream, pViewHitList, runningFitPositionVector, unavailableHitList, showerSpineHitList);
             }
         }
         catch (const StatusCodeException &)
         {
             return;
         }
     }
 }

float lar_content::ShowerSpineFinderTool::GetClosestDistance	(	const pandora::CartesianVector &	position,
		const pandora::CartesianPointVector &	testPositions
	)		const

private

Find the smallest distance between a position and a list of other positions.

Parameters

position	the input position
testPositions	the list of other positions

Returns: the closest distance

Definition at line 262 of file ShowerSpineFinderTool.cc.

Referenced by CollectConnectedHits().

 {
     float closestDistanceSqaured(std::numeric_limits<float>::max());
 
     for (const CartesianVector &testPosition : testPositions)
     {
         const float separationSquared((testPosition - position).GetMagnitudeSquared());
 
         if (separationSquared < closestDistanceSqaured)
             closestDistanceSqaured = separationSquared;
     }
 
     return std::sqrt(closestDistanceSqaured);
 }

bool lar_content::ShowerSpineFinderTool::IsCloseToLine	(	const pandora::CartesianVector &	hitPosition,
		const pandora::CartesianVector &	lineStart,
		const pandora::CartesianVector &	lineDirection,
		const float	distanceToLine
	)		const

private

Determine whether a hit lies close to the shower spine projection.

Parameters

hitPosition	the hit position
lineStart	the shower spine projection start position
lineDirection	the shower spine projection direction
distanceToLine	the comparison distance for 'is close'

Returns: whether the hit is close to the shower spine projection

Definition at line 215 of file ShowerSpineFinderTool.cc.

Referenced by CollectSubsectionHits().

 {
     const float transverseDistanceFromLine(lineDirection.GetCrossProduct(hitPosition - lineStart).GetMagnitude());
 
     if (transverseDistanceFromLine > distanceToLine)
         return false;
 
     return true;
 }

StatusCode lar_content::ShowerSpineFinderTool::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

private

Definition at line 279 of file ShowerSpineFinderTool.cc.

References m_distanceToLine, m_growingFitInitialLength, m_growingFitSegmentLength, m_highResolutionSlidingFitWindow, m_hitConnectionDistance, m_hitThresholdForSpine, m_initialFitDistanceToLine, m_localSlidingFitWindow, m_maxFittingHits, and m_minInitialHitsFound.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "HitThresholdForSpine", m_hitThresholdForSpine));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "GrowingFitInitialLength", m_growingFitInitialLength));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "InitialFitDistanceToLine", m_initialFitDistanceToLine));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinInitialHitsFound", m_minInitialHitsFound));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxFittingHits", m_maxFittingHits));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "LocalSlidingFitWindow", m_localSlidingFitWindow));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "GrowingFitSegmentLength", m_growingFitSegmentLength));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "HighResolutionSlidingFitWindow", m_highResolutionSlidingFitWindow));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "DistanceToLine", m_distanceToLine));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "HitConnectionDistance", m_hitConnectionDistance));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::ShowerSpineFinderTool::Run	(	const pandora::CartesianVector &	nuVertex3D,
		const pandora::CaloHitList *const	pViewHitList,
		const pandora::HitType	hitType,
		const pandora::CartesianVector &	peakDirection,
		pandora::CaloHitList &	unavailableHitList,
		pandora::CaloHitList &	showerSpineHitList
	)

Definition at line 41 of file ShowerSpineFinderTool.cc.

References FindShowerSpine(), m_hitThresholdForSpine, and lar_content::LArGeometryHelper::ProjectPosition().

Referenced by lar_content::ElectronInitialRegionRefinementAlgorithm::BuildViewPathways(), and lar_content::ElectronInitialRegionRefinementAlgorithm::BuildViewProtoShowers().

 {
     const CartesianVector nuVertex2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), nuVertex3D, hitType));
 
     this->FindShowerSpine(pViewHitList, nuVertex2D, peakDirection, unavailableHitList, showerSpineHitList);
 
     // Demand that spine is significant, be lenient here as some have small stubs and a gap
     if (showerSpineHitList.size() < m_hitThresholdForSpine)
         return STATUS_CODE_NOT_FOUND;
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

float lar_content::ShowerSpineFinderTool::m_distanceToLine

private

The max. proximity to the spine projection for collection.

Definition at line 106 of file ShowerSpineFinderTool.h.

Referenced by CollectSubsectionHits(), and ReadSettings().

float lar_content::ShowerSpineFinderTool::m_growingFitInitialLength

private

The first step distance.

Definition at line 99 of file ShowerSpineFinderTool.h.

Referenced by FindShowerSpine(), and ReadSettings().

float lar_content::ShowerSpineFinderTool::m_growingFitSegmentLength

private

The standard step distance.

Definition at line 104 of file ShowerSpineFinderTool.h.

Referenced by FindShowerSpine(), and ReadSettings().

unsigned int lar_content::ShowerSpineFinderTool::m_highResolutionSlidingFitWindow

private

The high resolution sliding fit window for spine fits.

Definition at line 105 of file ShowerSpineFinderTool.h.

Referenced by FindShowerSpine(), and ReadSettings().

float lar_content::ShowerSpineFinderTool::m_hitConnectionDistance

private

The max. separation between connected hits.

Definition at line 107 of file ShowerSpineFinderTool.h.

Referenced by CollectConnectedHits(), and ReadSettings().

unsigned int lar_content::ShowerSpineFinderTool::m_hitThresholdForSpine

private

The hit threshold for a significant spine.

Definition at line 98 of file ShowerSpineFinderTool.h.

Referenced by ReadSettings(), and Run().

float lar_content::ShowerSpineFinderTool::m_initialFitDistanceToLine

private

The max. proximity to the spine projection for collection in the first step.

Definition at line 100 of file ShowerSpineFinderTool.h.

Referenced by FindShowerSpine(), and ReadSettings().

unsigned int lar_content::ShowerSpineFinderTool::m_localSlidingFitWindow

private

The standard sliding fit window for spine fits.

Definition at line 103 of file ShowerSpineFinderTool.h.

Referenced by FindShowerSpine(), and ReadSettings().

unsigned int lar_content::ShowerSpineFinderTool::m_maxFittingHits

private

The number of hits to consider in the running fit.

Definition at line 102 of file ShowerSpineFinderTool.h.

Referenced by FindShowerSpine(), and ReadSettings().

unsigned int lar_content::ShowerSpineFinderTool::m_minInitialHitsFound

private

The min. number of hits collected in the first step for continuation.

Definition at line 101 of file ShowerSpineFinderTool.h.

Referenced by FindShowerSpine(), and ReadSettings().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArShowerRefinement/ShowerSpineFinderTool.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArShowerRefinement/ShowerSpineFinderTool.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation