#include "PeakDirectionFinderTool.h"

Inheritance diagram for lar_content::PeakDirectionFinderTool:

[legend]

Collaboration diagram for lar_content::PeakDirectionFinderTool:

[legend]

Public Member Functions
	PeakDirectionFinderTool ()
	Default constructor.

pandora::StatusCode	Run (const pandora::ParticleFlowObject const pShowerPfo, const pandora::CartesianVector &nuVertex3D, const pandora::CaloHitList const pViewHitList, const pandora::HitType hitType, pandora::CartesianPointVector &peakDirectionVector)

const std::string &	GetType () const
	Get the type.

const std::string &	GetInstanceName () const
	Get the instance name.

const Pandora &	GetPandora () const
	Get the associated pandora instance.

Protected Member Functions
virtual StatusCode	Initialize ()
	Perform any operations that must occur after reading settings, but before running the process.

virtual StatusCode	Reset ()
	Perform any operations when pandora is reset, typically at the end of each event.

StatusCode	RegisterDetails (const Pandora *const pPandora, const std::string &type, const std::string &instanceName)
	Register i) the pandora instance that will run the process and ii) the process type.

Protected Attributes
const Pandora *	m_pPandora
	The pandora object that will run the process.

std::string	m_type
	The process type.

std::string	m_instanceName
	The process instance name.

Private Types
typedef std::map< int, float >	AngularDecompositionMap

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
	Read the algorithm settings.

void	CollectHitsWithinROI (const pandora::CaloHitList &showerHitList, const pandora::CaloHitList *const pViewHitList, const pandora::CartesianVector &nuVertex2D, pandora::CaloHitList &viewROIHits) const
	Collect the 2D hits within a region of interest (m_ambiguousParticleMode ? hits not in the shower : hits within the initial shower cone [originating from the nu vertex])

void	GetAngularExtrema (const pandora::CaloHitList &showerHitList, const pandora::CartesianVector &nuVertex2D, float &lowestTheta, float &highestTheta) const
	Determine the angle (from the +ve drift-axis) of the shower cone boundaries (originating from the nu vertex)

void	CollectHitsWithinExtrema (const pandora::CaloHitList *const pViewHitList, const pandora::CartesianVector &nuVertex2D, const float lowestTheta, const float highestTheta, pandora::CaloHitList &viewROIHits) const
	Collect the hits that lie within the initial shower cone (originating from the nu vertex)

void	FillAngularDecompositionMap (const pandora::CaloHitList &viewShowerHitList, const pandora::CartesianVector &nuVertex2D, AngularDecompositionMap &angularDecompositionMap) const
	Determine the angular distribution of the ROI hits.

void	SmoothAngularDecompositionMap (AngularDecompositionMap &angularDecompositionMap) const
	Smooth the ROI angular angular distribution.

void	RetrievePeakDirections (const AngularDecompositionMap &angularDecompositionMap, pandora::CartesianPointVector &peakDirectionVector) const
	Obtain a vector of directions from the angular distribution peaks.

Private Attributes
float	m_pathwaySearchRegion
	The initial shower cone distance.

float	m_theta0XZBinSize
	The angular distribution bin size.

int	m_smoothingWindow
	On each side, the number of neighbouring bins with which each bin is averaged.

bool	m_ambiguousParticleMode
	Whether to find the initial pathway direction of the shower or of the other event particles.

Detailed Description

Definition at line 17 of file PeakDirectionFinderTool.h.

Member Typedef Documentation

◆ AngularDecompositionMap

typedef std::map<int, float> lar_content::PeakDirectionFinderTool::AngularDecompositionMap

private

Definition at line 29 of file PeakDirectionFinderTool.h.

Constructor & Destructor Documentation

◆ PeakDirectionFinderTool()

lar_content::PeakDirectionFinderTool::PeakDirectionFinderTool ( )

Default constructor.

Definition at line 22 of file PeakDirectionFinderTool.cc.

Member Function Documentation

◆ CollectHitsWithinExtrema()

void lar_content::PeakDirectionFinderTool::CollectHitsWithinExtrema	(	const pandora::CaloHitList *const	pViewHitList,
		const pandora::CartesianVector &	nuVertex2D,
		const float	lowestTheta,
		const float	highestTheta,
		pandora::CaloHitList &	viewROIHits
	)		const

private

Collect the hits that lie within the initial shower cone (originating from the nu vertex)

Parameters

pViewHitList	the event 2D hits list
nuVertex2D	the 2D neutrino vertex
lowestTheta	the lower angle (from the +ve drift-axis) boundary
highestTheta	the higher angle (from the +ve drift-axis) boundary
viewROIHits	the region of interest 2D hit list

Definition at line 120 of file PeakDirectionFinderTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CollectHitsWithinROI()

void lar_content::PeakDirectionFinderTool::CollectHitsWithinROI	(	const pandora::CaloHitList &	showerHitList,
		const pandora::CaloHitList *const	pViewHitList,
		const pandora::CartesianVector &	nuVertex2D,
		pandora::CaloHitList &	viewROIHits
	)		const

private

Collect the 2D hits within a region of interest (m_ambiguousParticleMode ? hits not in the shower : hits within the initial shower cone [originating from the nu vertex])

Parameters

showerHitList	the 2D shower hit list
pViewHitList	the event 2D hits list
nuVertex2D	the 2D neutrino vertex
viewROIHits	the region of interest 2D hit list

Definition at line 68 of file PeakDirectionFinderTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FillAngularDecompositionMap()

void lar_content::PeakDirectionFinderTool::FillAngularDecompositionMap	(	const pandora::CaloHitList &	viewShowerHitList,
		const pandora::CartesianVector &	nuVertex2D,
		AngularDecompositionMap &	angularDecompositionMap
	)		const

private

Determine the angular distribution of the ROI hits.

Parameters

viewShowerHitList	the 2D shower hit list
nuVertex2D	the 2D neutrino vertex
angularDecompositionMap	the output [angle from drift-axis -> weight] map

Definition at line 144 of file PeakDirectionFinderTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAngularExtrema()

void lar_content::PeakDirectionFinderTool::GetAngularExtrema	(	const pandora::CaloHitList &	showerHitList,
		const pandora::CartesianVector &	nuVertex2D,
		float &	lowestTheta,
		float &	highestTheta
	)		const

private

Determine the angle (from the +ve drift-axis) of the shower cone boundaries (originating from the nu vertex)

Parameters

showerHitList	the 2D shower hit list
nuVertex2D	the 2D neutrino vertex
lowestTheta	the lower angle boundary
highestTheta	the higher angle boundary

Definition at line 92 of file PeakDirectionFinderTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInstanceName()

const std::string & pandora::Process::GetInstanceName ( ) const

inlineinherited

Get the instance name.

Returns: The instance name

Definition at line 109 of file Process.h.

◆ GetPandora()

const Pandora & pandora::Process::GetPandora ( ) const

inlineinherited

Get the associated pandora instance.

Returns: the associated pandora instance

Definition at line 116 of file Process.h.

◆ GetType()

const std::string & pandora::Process::GetType ( ) const

inlineinherited

Get the type.

Returns: The type

Definition at line 102 of file Process.h.

◆ Initialize()

StatusCode pandora::Process::Initialize ( )

inlineprotectedvirtualinherited

Perform any operations that must occur after reading settings, but before running the process.

Reimplemented in lar_content::BdtBeamParticleIdTool, lar_content::BeamParticleIdTool, lar_content::CosmicRayTaggingTool, lar_content::EventReadingAlgorithm, lar_content::EventWritingAlgorithm, lar_content::LArPseudoLayerPlugin, lar_content::LArRotationalTransformationPlugin, EventReadingAlgorithm, and EventWritingAlgorithm.

Definition at line 126 of file Process.h.

Here is the caller graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 272 of file PeakDirectionFinderTool.cc.

Here is the call graph for this function:

◆ RegisterDetails()

StatusCode pandora::Process::RegisterDetails	(	const Pandora *const	pPandora,
		const std::string &	type,
		const std::string &	instanceName
	)

inlineprotectedinherited

Register i) the pandora instance that will run the process and ii) the process type.

Parameters

pPandora	address of the pandora object that will run the process
type	the process type
instanceName	the process instance name

Definition at line 146 of file Process.h.

Here is the caller graph for this function:

◆ Reset()

StatusCode pandora::Process::Reset ( )

inlineprotectedvirtualinherited

Perform any operations when pandora is reset, typically at the end of each event.

Reimplemented in lar_content::MasterAlgorithm, lar_content::PostProcessingAlgorithm, and lar_content::PreProcessingAlgorithm.

Definition at line 133 of file Process.h.

Here is the caller graph for this function:

◆ RetrievePeakDirections()

void lar_content::PeakDirectionFinderTool::RetrievePeakDirections	(	const AngularDecompositionMap &	angularDecompositionMap,
		pandora::CartesianPointVector &	peakDirectionVector
	)		const

private

Obtain a vector of directions from the angular distribution peaks.

Parameters

angularDecompositionMap	the [angle from drift-axis -> weight] map
peakDirectionVector	the output peak direction vector

Definition at line 201 of file PeakDirectionFinderTool.cc.

Here is the caller graph for this function:

◆ Run()

StatusCode lar_content::PeakDirectionFinderTool::Run	(	const pandora::ParticleFlowObject *const	pShowerPfo,
		const pandora::CartesianVector &	nuVertex3D,
		const pandora::CaloHitList *const	pViewHitList,
		const pandora::HitType	hitType,
		pandora::CartesianPointVector &	peakDirectionVector
	)

Definition at line 32 of file PeakDirectionFinderTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SmoothAngularDecompositionMap()

void lar_content::PeakDirectionFinderTool::SmoothAngularDecompositionMap ( AngularDecompositionMap & angularDecompositionMap ) const

private

Smooth the ROI angular angular distribution.

Parameters

angularDecompositionMap the [angle from drift-axis -> weight] map

Definition at line 173 of file PeakDirectionFinderTool.cc.

Here is the caller graph for this function:

Member Data Documentation

◆ m_ambiguousParticleMode

bool lar_content::PeakDirectionFinderTool::m_ambiguousParticleMode

private

Whether to find the initial pathway direction of the shower or of the other event particles.

Definition at line 96 of file PeakDirectionFinderTool.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_pathwaySearchRegion

float lar_content::PeakDirectionFinderTool::m_pathwaySearchRegion

private

The initial shower cone distance.

Definition at line 93 of file PeakDirectionFinderTool.h.

◆ m_pPandora

const Pandora* pandora::Process::m_pPandora

protectedinherited

The pandora object that will run the process.

Definition at line 87 of file Process.h.

◆ m_smoothingWindow

int lar_content::PeakDirectionFinderTool::m_smoothingWindow

private

On each side, the number of neighbouring bins with which each bin is averaged.

Definition at line 95 of file PeakDirectionFinderTool.h.

◆ m_theta0XZBinSize

float lar_content::PeakDirectionFinderTool::m_theta0XZBinSize

private

The angular distribution bin size.

Definition at line 94 of file PeakDirectionFinderTool.h.

◆ m_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

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

LArContent/larpandoracontent/LArShowerRefinement/PeakDirectionFinderTool.h
LArContent/larpandoracontent/LArShowerRefinement/PeakDirectionFinderTool.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ AngularDecompositionMap

Constructor & Destructor Documentation

◆ PeakDirectionFinderTool()

Member Function Documentation

◆ CollectHitsWithinExtrema()

◆ CollectHitsWithinROI()

◆ FillAngularDecompositionMap()

◆ GetAngularExtrema()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ RetrievePeakDirections()

◆ Run()

◆ SmoothAngularDecompositionMap()

Member Data Documentation

◆ m_ambiguousParticleMode

◆ m_instanceName

◆ m_pathwaySearchRegion

◆ m_pPandora

◆ m_smoothingWindow

◆ m_theta0XZBinSize

◆ m_type