#include "ShowerHitsBaseTool.h"

Inheritance diagram for lar_content::ShowerHitsBaseTool:

Public Types
typedef ThreeDHitCreationAlgorithm::ProtoHit	ProtoHit

typedef ThreeDHitCreationAlgorithm::ProtoHitVector	ProtoHitVector

typedef ThreeDHitCreationAlgorithm::TrajectorySample	TrajectorySample

Public Member Functions
	ShowerHitsBaseTool ()
	Default constructor. More...

virtual void	Run (ThreeDHitCreationAlgorithm const pAlgorithm, const pandora::ParticleFlowObject const pPfo, const pandora::CaloHitVector &inputTwoDHits, ProtoHitVector &protoHitVector)
	Run the algorithm tool. More...

Protected Member Functions
virtual void	GetShowerHit3D (const pandora::CaloHitVector &caloHitVector1, const pandora::CaloHitVector &caloHitVector2, ProtoHit &protoHit) const =0
	Get the three dimensional position for to a two dimensional calo hit, using the hit and a list of candidate matched hits in the other two views. More...

virtual void	GetShowerHits3D (const pandora::CaloHitVector &inputTwoDHits, const pandora::CaloHitVector &caloHitVector1, const pandora::CaloHitVector &caloHitVector2, ProtoHitVector &protoHitVector) const
	Create three dimensional hits, using a list of input two dimensional hits and the hits (contained in the same particle) from the other two views. More...

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

virtual void	GetBestPosition3D (const pandora::HitType hitType1, const pandora::HitType hitType2, const pandora::CartesianPointVector &fitPositionList1, const pandora::CartesianPointVector &fitPositionList2, ProtoHit &protoHit) const
	Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views. More...

virtual void	GetBestPosition3D (const pandora::HitType hitType1, const pandora::HitType hitType2, const pandora::CartesianVector &fitPosition1, const pandora::CartesianVector &fitPosition2, ProtoHit &protoHit) const
	Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views. More...

virtual void	GetBestPosition3D (const pandora::HitType hitType, const pandora::CartesianVector &fitPosition, ProtoHit &protoHit) const
	Get the three dimensional position using a provided two dimensional calo hit and a candidate fit position from another view. More...

Protected Attributes
double	m_sigmaX2
	The sigmaX squared value, for calculation of chi2 deltaX term. More...

double	m_chiSquaredCut
	The chi squared cut (accept only values below the cut value) More...

Private Member Functions
void	FilterCaloHits (const float x, const float xTolerance, const pandora::CaloHitVector &inputCaloHitVector, pandora::CaloHitVector &outputCaloHitVector) const
	Filter a list of calo hits to find those within a specified tolerance of a give x position. More...

Private Attributes
float	m_xTolerance
	The x tolerance to use when looking for associated calo hits between views. More...

Detailed Description

ShowerHitsBaseTool class.

Definition at line 19 of file ShowerHitsBaseTool.h.

Member Typedef Documentation

typedef ThreeDHitCreationAlgorithm::ProtoHit lar_content::HitCreationBaseTool::ProtoHit

inherited

Definition at line 24 of file HitCreationBaseTool.h.

typedef ThreeDHitCreationAlgorithm::ProtoHitVector lar_content::HitCreationBaseTool::ProtoHitVector

inherited

Definition at line 25 of file HitCreationBaseTool.h.

typedef ThreeDHitCreationAlgorithm::TrajectorySample lar_content::HitCreationBaseTool::TrajectorySample

inherited

Definition at line 26 of file HitCreationBaseTool.h.

Constructor & Destructor Documentation

lar_content::ShowerHitsBaseTool::ShowerHitsBaseTool ( )

Default constructor.

Definition at line 21 of file ShowerHitsBaseTool.cc.

                                        :
     m_xTolerance(1.f)
 {
 }

Member Function Documentation

void lar_content::ShowerHitsBaseTool::FilterCaloHits	(	const float	x,
		const float	xTolerance,
		const pandora::CaloHitVector &	inputCaloHitVector,
		pandora::CaloHitVector &	outputCaloHitVector
	)		const

private

Filter a list of calo hits to find those within a specified tolerance of a give x position.

Parameters

x	the x position
xTolerance	the x tolerance
inputCaloHitVector	the input calo hit vector
outputCaloHitVector	to receive the output calo hit vector

Definition at line 80 of file ShowerHitsBaseTool.cc.

References x.

Referenced by GetShowerHits3D().

 {
     for (const CaloHit *const pCaloHit : inputCaloHitVector)
     {
         const float deltaX(pCaloHit->GetPositionVector().GetX() - x);
 
         if (std::fabs(deltaX) < xTolerance)
             outputCaloHitVector.push_back(pCaloHit);
     }
 }

virtual void lar_content::HitCreationBaseTool::GetBestPosition3D	(	const pandora::HitType	hitType1,
		const pandora::HitType	hitType2,
		const pandora::CartesianPointVector &	fitPositionList1,
		const pandora::CartesianPointVector &	fitPositionList2,
		ProtoHit &	protoHit
	)		const

protectedvirtualinherited

Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views.

Parameters

hitType1	the hit type identifying the first view
hitType2	the hit type identifying the second view
fitPositionList1	the candidate sliding fit position in the first view
fitPositionList2	the candidate sliding fit position in the second view
protoHit	to receive the populated proto hit

Referenced by lar_content::ThreeViewShowerHitsTool::GetShowerHit3D(), and lar_content::HitCreationBaseTool::~HitCreationBaseTool().

virtual void lar_content::HitCreationBaseTool::GetBestPosition3D	(	const pandora::HitType	hitType1,
		const pandora::HitType	hitType2,
		const pandora::CartesianVector &	fitPosition1,
		const pandora::CartesianVector &	fitPosition2,
		ProtoHit &	protoHit
	)		const

protectedvirtualinherited

Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views.

Parameters

hitType1	the hit type identifying the first view
hitType2	the hit type identifying the second view
fitPosition1	the candidate sliding fit position in the first view
fitPosition2	the candidate sliding fit position in the second view
protoHit	to receive the populated proto hit

virtual void lar_content::HitCreationBaseTool::GetBestPosition3D	(	const pandora::HitType	hitType,
		const pandora::CartesianVector &	fitPosition,
		ProtoHit &	protoHit
	)		const

protectedvirtualinherited

Get the three dimensional position using a provided two dimensional calo hit and a candidate fit position from another view.

Parameters

hitType	the hit type identifying the other view
fitPosition	the candidate sliding fit position in the other view
protoHit	to receive the populated proto hit

virtual void lar_content::ShowerHitsBaseTool::GetShowerHit3D	(	const pandora::CaloHitVector &	caloHitVector1,
		const pandora::CaloHitVector &	caloHitVector2,
		ProtoHit &	protoHit
	)		const

protectedpure virtual

Get the three dimensional position for to a two dimensional calo hit, using the hit and a list of candidate matched hits in the other two views.

Parameters

caloHitVector1	the vector of candidate hits in view 1
caloHitVector2	the vector of candidate hits in view 2
protoHit	to receive the populated proto hit

Implemented in lar_content::ThreeViewShowerHitsTool, and lar_content::TwoViewShowerHitsTool.

Referenced by GetShowerHits3D().

void lar_content::ShowerHitsBaseTool::GetShowerHits3D	(	const pandora::CaloHitVector &	inputTwoDHits,
		const pandora::CaloHitVector &	caloHitVector1,
		const pandora::CaloHitVector &	caloHitVector2,
		ProtoHitVector &	protoHitVector
	)		const

protectedvirtual

Create three dimensional hits, using a list of input two dimensional hits and the hits (contained in the same particle) from the other two views.

Parameters

inputTwoDHits	the list of input two dimensional hits
caloHitVector1	hits in the first alternate view
caloHitVector2	hits in the second alternate view
protoHitVector	to receive the new three dimensional proto hits

Definition at line 55 of file ShowerHitsBaseTool.cc.

References FilterCaloHits(), GetShowerHit3D(), lar_content::HitCreationBaseTool::m_chiSquaredCut, and m_xTolerance.

Referenced by Run().

 {
     for (const CaloHit *const pCaloHit2D : inputTwoDHits)
     {
         try
         {
             CaloHitVector filteredHits1, filteredHits2;
             this->FilterCaloHits(pCaloHit2D->GetPositionVector().GetX(), m_xTolerance, caloHitVector1, filteredHits1);
             this->FilterCaloHits(pCaloHit2D->GetPositionVector().GetX(), m_xTolerance, caloHitVector2, filteredHits2);
 
             ProtoHit protoHit(pCaloHit2D);
             this->GetShowerHit3D(filteredHits1, filteredHits2, protoHit);
 
             if (protoHit.IsPositionSet() && (protoHit.GetChi2() < m_chiSquaredCut))
                 protoHitVector.push_back(protoHit);
         }
         catch (StatusCodeException &)
         {
         }
     }
 }

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

protectedvirtual

Reimplemented from lar_content::HitCreationBaseTool.

Reimplemented in lar_content::ThreeViewShowerHitsTool.

Definition at line 94 of file ShowerHitsBaseTool.cc.

References m_xTolerance, and lar_content::HitCreationBaseTool::ReadSettings().

Referenced by lar_content::ThreeViewShowerHitsTool::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "XTolerance", m_xTolerance));
 
     return HitCreationBaseTool::ReadSettings(xmlHandle);
 }

void lar_content::ShowerHitsBaseTool::Run	(	ThreeDHitCreationAlgorithm *const	pAlgorithm,
		const pandora::ParticleFlowObject *const	pPfo,
		const pandora::CaloHitVector &	inputTwoDHits,
		ProtoHitVector &	protoHitVector
	)

virtual

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
pPfo	the address of the pfo
inputTwoDHits	the vector of input two dimensional hits
protoHitVector	to receive the new three dimensional proto hits

Implements lar_content::HitCreationBaseTool.

Definition at line 28 of file ShowerHitsBaseTool.cc.

References lar_content::ThreeDHitCreationAlgorithm::FilterCaloHitsByType(), GetShowerHits3D(), and lar_content::LArPfoHelper::IsShower().

 {
     if (PandoraContentApi::GetSettings(*pAlgorithm)->ShouldDisplayAlgorithmInfo())
        std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;
 
     try
     {
         if (!LArPfoHelper::IsShower(pPfo))
             return;
 
         CaloHitVector caloHitVectorU, caloHitVectorV, caloHitVectorW;
         pAlgorithm->FilterCaloHitsByType(inputTwoDHits, TPC_VIEW_U, caloHitVectorU);
         pAlgorithm->FilterCaloHitsByType(inputTwoDHits, TPC_VIEW_V, caloHitVectorV);
         pAlgorithm->FilterCaloHitsByType(inputTwoDHits, TPC_VIEW_W, caloHitVectorW);
 
         this->GetShowerHits3D(caloHitVectorU, caloHitVectorV, caloHitVectorW, protoHitVector);
         this->GetShowerHits3D(caloHitVectorV, caloHitVectorU, caloHitVectorW, protoHitVector);
         this->GetShowerHits3D(caloHitVectorW, caloHitVectorU, caloHitVectorV, protoHitVector);
     }
     catch (StatusCodeException &)
     {
     }
 }

Member Data Documentation

double lar_content::HitCreationBaseTool::m_chiSquaredCut

protectedinherited

The chi squared cut (accept only values below the cut value)

Definition at line 86 of file HitCreationBaseTool.h.

Referenced by GetShowerHits3D(), lar_content::LongitudinalTrackHitsBaseTool::GetTrackHits3D(), and lar_content::HitCreationBaseTool::ReadSettings().

double lar_content::HitCreationBaseTool::m_sigmaX2

protectedinherited

The sigmaX squared value, for calculation of chi2 deltaX term.

Definition at line 85 of file HitCreationBaseTool.h.

Referenced by lar_content::HitCreationBaseTool::ReadSettings(), and lar_content::HitCreationBaseTool::~HitCreationBaseTool().

float lar_content::ShowerHitsBaseTool::m_xTolerance

private

The x tolerance to use when looking for associated calo hits between views.

Definition at line 68 of file ShowerHitsBaseTool.h.

Referenced by GetShowerHits3D(), and ReadSettings().

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArHitCreation/ShowerHitsBaseTool.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArHitCreation/ShowerHitsBaseTool.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation