#include <PseudoLayerPlugin.h>

Inheritance diagram for gar::gar_pandora::PseudoLayerPlugin:

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

Private Types
typedef std::vector< float >	LayerPositionList

typedef std::vector< std::pair< float, float > >	AngleVector

Private Member Functions
pandora::StatusCode	Initialize ()

unsigned int	GetPseudoLayer (const pandora::CartesianVector &positionVector) const

unsigned int	GetPseudoLayerAtIp () const

pandora::StatusCode	GetPseudoLayer (const float rCoordinate, const float zCoordinate, const float rCorrection, const float zCorrection, const float barrelInnerR, const float endCapInnerZ, unsigned int &pseudoLayer) const
	Get the appropriate pseudolayer for a specified parameters. More...

pandora::StatusCode	FindMatchingLayer (const float position, const LayerPositionList &layerPositionList, unsigned int &layer) const
	Find the layer number corresponding to a specified position, via reference to a specified layer position list. More...

void	StoreLayerPositions ()
	Store all revelevant barrel and endcap layer positions upon initialization. More...

void	StoreLayerPositions (const pandora::SubDetector &subDetector, LayerPositionList &LayerPositionList)
	Store subdetector layer positions upon initialization. More...

void	StoreDetectorOuterEdge ()
	Store positions of barrel and endcap outer edges upon initialization. More...

void	StorePolygonAngles ()
	Store sine and cosine of angles used to project hit positions onto polygonal calorimeter surfaces upon initialization. More...

void	StoreOverlapCorrectionDetails ()
	Store all details revelevant to barrel/endcap overlap corrections upon initialization. More...

float	GetMaximumRadius (const AngleVector &angleVector, const float x, const float y) const
	Get the maximum polygon radius, with reference to cached sine/cosine values for relevant polygon angles. More...

void	FillAngleVector (const unsigned int symmetryOrder, const float phi0, AngleVector &angleVector) const
	Fill a vector with sine/cosine values for relevant polygon angles. More...

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

Private Attributes
LayerPositionList	m_barrelLayerPositions
	List of barrel layer positions. More...

LayerPositionList	m_endCapLayerPositions
	List of endcap layer positions. More...

AngleVector	m_eCalBarrelAngleVector
	The ecal barrel angle vector. More...

float	m_barrelInnerR
	Barrel inner radius. More...

float	m_endCapInnerZ
	Endcap inner z position. More...

float	m_rCorrection
	Barrel/endcap overlap r correction. More...

float	m_zCorrection
	Barrel/endcap overlap z correction. More...

float	m_barrelEdgeR
	Extremal barrel r coordinate. More...

float	m_endCapEdgeZ
	Extremal endcap z coordinate. More...

Detailed Description

Definition at line 22 of file PseudoLayerPlugin.h.

Member Typedef Documentation

typedef std::vector< std::pair<float, float> > gar::gar_pandora::PseudoLayerPlugin::AngleVector

private

Definition at line 90 of file PseudoLayerPlugin.h.

typedef std::vector<float> gar::gar_pandora::PseudoLayerPlugin::LayerPositionList

private

Definition at line 51 of file PseudoLayerPlugin.h.

Constructor & Destructor Documentation

gar::gar_pandora::PseudoLayerPlugin::PseudoLayerPlugin ( )

Default constructor.

Definition at line 14 of file PseudoLayerPlugin.cxx.

         : m_barrelInnerR(0.f),
         m_endCapInnerZ(0.f),
         m_rCorrection(0.f),
         m_zCorrection(0.f),
         m_barrelEdgeR(0.f),
         m_endCapEdgeZ(0.f)
         {}

Member Function Documentation

void gar::gar_pandora::PseudoLayerPlugin::FillAngleVector	(	const unsigned int	symmetryOrder,
		const float	phi0,
		AngleVector &	angleVector
	)		const

private

Fill a vector with sine/cosine values for relevant polygon angles.

Parameters

symmetryOrder	the polygon symmetry order
phi0	the polygon cylindrical polar phi coordinate
angleVector	the vector to fill with sine/cosine values for relevant polygon angles

Definition at line 249 of file PseudoLayerPlugin.cxx.

         {
             const float twoPi = static_cast<float>(2. * std::acos(-1.));
             angleVector.clear();
 
             for (unsigned int iSymmetry = 0; iSymmetry < symmetryOrder; ++iSymmetry)
             {
                 const float phi = phi0 + ((twoPi * static_cast<float>(iSymmetry)) / static_cast<float>(symmetryOrder));
                 angleVector.push_back(std::make_pair(std::cos(phi), std::sin(phi)));
             }
         }

StatusCode gar::gar_pandora::PseudoLayerPlugin::FindMatchingLayer	(	const float	position,
		const LayerPositionList &	layerPositionList,
		unsigned int &	layer
	)		const

private

Find the layer number corresponding to a specified position, via reference to a specified layer position list.

Parameters

position	the specified position
layerPositionList	the specified layer position list
layer	to receive the layer number

Definition at line 106 of file PseudoLayerPlugin.cxx.

         {
             LayerPositionList::const_iterator upperIter = std::upper_bound(layerPositionList.begin(), layerPositionList.end(), position);
 
             if (layerPositionList.end() == upperIter)
             {
                 return STATUS_CODE_NOT_FOUND;
             }
 
             if (layerPositionList.begin() == upperIter)
             {
                 layer = 0;
                 return STATUS_CODE_SUCCESS;
             }
 
             LayerPositionList::const_iterator lowerIter = upperIter - 1;
 
             if (std::fabs(position - *lowerIter) < std::fabs(position - *upperIter))
             {
                 layer = std::distance(layerPositionList.begin(), lowerIter);
             }
             else
             {
                 layer = std::distance(layerPositionList.begin(), upperIter);
             }
 
             return STATUS_CODE_SUCCESS;
         }

float gar::gar_pandora::PseudoLayerPlugin::GetMaximumRadius	(	const AngleVector &	angleVector,
		const float	x,
		const float	y
	)		const

private

Get the maximum polygon radius, with reference to cached sine/cosine values for relevant polygon angles.

Parameters

angleVector	vector containing cached sine/cosine values
x	the cartesian x coordinate
y	the cartesian y coordinate

Returns: the maximum radius

Definition at line 230 of file PseudoLayerPlugin.cxx.

         {
             if (angleVector.size() <= 2)
             return std::sqrt((x * x) + (y * y));
 
             float maxRadius(0.);
             for (AngleVector::const_iterator iter = angleVector.begin(), iterEnd = angleVector.end(); iter != iterEnd; ++iter)
             {
                 const float radius((x * iter->first) + (y * iter->second));
 
                 if (radius > maxRadius)
                 maxRadius = radius;
             }
 
             return maxRadius;
         }

unsigned int gar::gar_pandora::PseudoLayerPlugin::GetPseudoLayer ( const pandora::CartesianVector & positionVector ) const

private

Definition at line 45 of file PseudoLayerPlugin.cxx.

         {
             const float zCoordinate(std::fabs(positionVector.GetZ()));
 
             if (zCoordinate > m_endCapEdgeZ) {
                 MF_LOG_WARNING("PseudoLayerPlugin::GetPseudoLayer")
                 << "zCoordinate " << zCoordinate << " > m_endCapEdgeZ " << m_endCapEdgeZ << std::endl;
                 throw StatusCodeException(STATUS_CODE_NOT_FOUND);
             }
 
             const float rCoordinate(this->GetMaximumRadius(m_eCalBarrelAngleVector, positionVector.GetX(), positionVector.GetY()));
 
             if (rCoordinate > m_barrelEdgeR) {
                 MF_LOG_WARNING("PseudoLayerPlugin::GetPseudoLayer")
                 << "rCoordinate " << rCoordinate << " > m_barrelEdgeR " << m_barrelEdgeR << std::endl;
                 throw StatusCodeException(STATUS_CODE_NOT_FOUND);
             }
 
             unsigned int pseudoLayer;
 
             const StatusCode statusCode(this->GetPseudoLayer(rCoordinate, zCoordinate, m_rCorrection, m_zCorrection, m_barrelInnerR,
             m_endCapInnerZ, pseudoLayer));
 
             if (STATUS_CODE_SUCCESS != statusCode)
             throw StatusCodeException(statusCode);
 
             // Reserve a pseudo layer for track projections, etc.
             return (1 + pseudoLayer);
         }

StatusCode gar::gar_pandora::PseudoLayerPlugin::GetPseudoLayer	(	const float	rCoordinate,
		const float	zCoordinate,
		const float	rCorrection,
		const float	zCorrection,
		const float	barrelInnerR,
		const float	endCapInnerZ,
		unsigned int &	pseudoLayer
	)		const

private

Get the appropriate pseudolayer for a specified parameters.

Parameters

rCoordinate	the radial coordinate
zCoordinate	the z coordinate
rCorrection	the barrel/endcap overlap r correction
zCorrection	the barrel/endcap overlap z correction
barrelInnerR	the barrel inner r coordinate
endCapInnerZ	the endcap inner z coordinate
pseudoLayer	to receive the appropriate pseudolayer

Definition at line 77 of file PseudoLayerPlugin.cxx.

         {
             if (zCoordinate < endCapInnerZ)
             {
                 return this->FindMatchingLayer(rCoordinate, m_barrelLayerPositions, pseudoLayer);
             }
             else if (rCoordinate < barrelInnerR)
             {
                 return this->FindMatchingLayer(zCoordinate, m_endCapLayerPositions, pseudoLayer);
             }
             else
             {
                 unsigned int bestBarrelLayer(0);
                 const StatusCode barrelStatusCode(this->FindMatchingLayer(rCoordinate - rCorrection, m_barrelLayerPositions, bestBarrelLayer));
 
                 unsigned int bestEndCapLayer(0);
                 const StatusCode endCapStatusCode(this->FindMatchingLayer(zCoordinate - zCorrection, m_endCapLayerPositions, bestEndCapLayer));
 
                 if ((STATUS_CODE_SUCCESS != barrelStatusCode) && (STATUS_CODE_SUCCESS != endCapStatusCode))
                 return STATUS_CODE_NOT_FOUND;
 
                 pseudoLayer = std::max(bestBarrelLayer, bestEndCapLayer);
                 return STATUS_CODE_SUCCESS;
             }
         }

unsigned int gar::gar_pandora::PseudoLayerPlugin::GetPseudoLayerAtIp ( ) const

inlineprivate

Definition at line 130 of file PseudoLayerPlugin.h.

         {
             const unsigned int pseudoLayerAtIp(this->GetPseudoLayer(pandora::CartesianVector(0.f, 0.f, 0.f)));
             return pseudoLayerAtIp;
         }

StatusCode gar::gar_pandora::PseudoLayerPlugin::Initialize ( )

private

Definition at line 25 of file PseudoLayerPlugin.cxx.

         {
             try
             {
                 this->StoreLayerPositions();
                 this->StoreDetectorOuterEdge();
                 this->StorePolygonAngles();
                 this->StoreOverlapCorrectionDetails();
             }
             catch (StatusCodeException &statusCodeException)
             {
                 std::cout << "PseudoLayerPlugin: Incomplete geometry - consider using a different PseudoLayerCalculator." << std::endl;
                 return statusCodeException.GetStatusCode();
             }
 
             return STATUS_CODE_SUCCESS;
         }

pandora::StatusCode gar::gar_pandora::PseudoLayerPlugin::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

private

Definition at line 263 of file PseudoLayerPlugin.cxx.

         {
             return STATUS_CODE_SUCCESS;
         }

void gar::gar_pandora::PseudoLayerPlugin::StoreDetectorOuterEdge ( )

private

Store positions of barrel and endcap outer edges upon initialization.

Definition at line 183 of file PseudoLayerPlugin.cxx.

         {
             const GeometryManager *const pGeometryManager(this->GetPandora().GetGeometry());
 
             m_barrelEdgeR = pGeometryManager->GetSubDetector(ECAL_BARREL).GetOuterRCoordinate();
 
             m_endCapEdgeZ = std::fabs(pGeometryManager->GetSubDetector(ECAL_ENDCAP).GetOuterZCoordinate());
 
             if ((m_barrelLayerPositions.end() != std::upper_bound(m_barrelLayerPositions.begin(), m_barrelLayerPositions.end(), m_barrelEdgeR)) || (m_endCapLayerPositions.end() != std::upper_bound(m_endCapLayerPositions.begin(), m_endCapLayerPositions.end(), m_endCapEdgeZ)))
             {
                 std::cout << "PseudoLayerPlugin: Layers specified outside detector edge." << std::endl;
                 throw StatusCodeException(STATUS_CODE_FAILURE);
             }
 
             m_barrelLayerPositions.push_back(m_barrelEdgeR);
             m_endCapLayerPositions.push_back(m_endCapEdgeZ);
         }

void gar::gar_pandora::PseudoLayerPlugin::StoreLayerPositions ( )

private

Store all revelevant barrel and endcap layer positions upon initialization.

Definition at line 138 of file PseudoLayerPlugin.cxx.

         {
             const GeometryManager *const pGeometryManager(this->GetPandora().GetGeometry());
             this->StoreLayerPositions(pGeometryManager->GetSubDetector(ECAL_BARREL), m_barrelLayerPositions);
             this->StoreLayerPositions(pGeometryManager->GetSubDetector(ECAL_ENDCAP), m_endCapLayerPositions);
 
             if (m_barrelLayerPositions.empty() || m_endCapLayerPositions.empty())
             {
                 std::cout << "PseudoLayerPlugin: No layer positions specified." << std::endl;
                 throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);
             }
 
             std::sort(m_barrelLayerPositions.begin(), m_barrelLayerPositions.end());
             std::sort(m_endCapLayerPositions.begin(), m_endCapLayerPositions.end());
 
             LayerPositionList::const_iterator barrelIter = std::unique(m_barrelLayerPositions.begin(), m_barrelLayerPositions.end());
             LayerPositionList::const_iterator endcapIter = std::unique(m_endCapLayerPositions.begin(), m_endCapLayerPositions.end());
 
             if ((m_barrelLayerPositions.end() != barrelIter) || (m_endCapLayerPositions.end() != endcapIter))
             {
                 std::cout << "PseudoLayerPlugin: Duplicate layer position detected." << std::endl;
                 throw StatusCodeException(STATUS_CODE_FAILURE);
             }
         }

void gar::gar_pandora::PseudoLayerPlugin::StoreLayerPositions	(	const pandora::SubDetector &	subDetector,
		LayerPositionList &	LayerPositionList
	)

private

Store subdetector layer positions upon initialization.

Parameters

subDetector	the sub detector
layerParametersList	the layer parameters list

void gar::gar_pandora::PseudoLayerPlugin::StoreOverlapCorrectionDetails ( )

private

Store all details revelevant to barrel/endcap overlap corrections upon initialization.

Definition at line 213 of file PseudoLayerPlugin.cxx.

         {
             const GeometryManager *const pGeometryManager(this->GetPandora().GetGeometry());
 
             m_barrelInnerR = pGeometryManager->GetSubDetector(ECAL_BARREL).GetInnerRCoordinate();
             m_endCapInnerZ = std::fabs(pGeometryManager->GetSubDetector(ECAL_ENDCAP).GetInnerZCoordinate());
 
             const float barrelOuterZ = std::fabs(pGeometryManager->GetSubDetector(ECAL_BARREL).GetOuterZCoordinate());
             const float endCapOuterR = pGeometryManager->GetSubDetector(ECAL_ENDCAP).GetOuterRCoordinate();
 
             const bool IsEnclosingEndCap(endCapOuterR > m_barrelInnerR);
             m_rCorrection = ((!IsEnclosingEndCap) ? 0.f : m_barrelInnerR * ((m_endCapInnerZ / barrelOuterZ) - 1.f));
             m_zCorrection = ((IsEnclosingEndCap) ? 0.f : m_endCapInnerZ * ((m_barrelInnerR / endCapOuterR) - 1.f));
         }

void gar::gar_pandora::PseudoLayerPlugin::StorePolygonAngles ( )

private

Store sine and cosine of angles used to project hit positions onto polygonal calorimeter surfaces upon initialization.

Definition at line 203 of file PseudoLayerPlugin.cxx.

         {
             const GeometryManager *const pGeometryManager(this->GetPandora().GetGeometry());
 
             this->FillAngleVector(pGeometryManager->GetSubDetector(ECAL_BARREL).GetInnerSymmetryOrder(),
             pGeometryManager->GetSubDetector(ECAL_BARREL).GetInnerPhiCoordinate(), m_eCalBarrelAngleVector);
         }

Member Data Documentation

float gar::gar_pandora::PseudoLayerPlugin::m_barrelEdgeR

private

Extremal barrel r coordinate.

Definition at line 124 of file PseudoLayerPlugin.h.

float gar::gar_pandora::PseudoLayerPlugin::m_barrelInnerR

private

Barrel inner radius.

Definition at line 118 of file PseudoLayerPlugin.h.

LayerPositionList gar::gar_pandora::PseudoLayerPlugin::m_barrelLayerPositions

private

List of barrel layer positions.

Definition at line 114 of file PseudoLayerPlugin.h.

AngleVector gar::gar_pandora::PseudoLayerPlugin::m_eCalBarrelAngleVector

private

The ecal barrel angle vector.

Definition at line 116 of file PseudoLayerPlugin.h.

float gar::gar_pandora::PseudoLayerPlugin::m_endCapEdgeZ

private

Extremal endcap z coordinate.

Definition at line 125 of file PseudoLayerPlugin.h.

float gar::gar_pandora::PseudoLayerPlugin::m_endCapInnerZ

private

Endcap inner z position.

Definition at line 119 of file PseudoLayerPlugin.h.

LayerPositionList gar::gar_pandora::PseudoLayerPlugin::m_endCapLayerPositions

private

List of endcap layer positions.

Definition at line 115 of file PseudoLayerPlugin.h.

float gar::gar_pandora::PseudoLayerPlugin::m_rCorrection

private

Barrel/endcap overlap r correction.

Definition at line 121 of file PseudoLayerPlugin.h.

float gar::gar_pandora::PseudoLayerPlugin::m_zCorrection

private

Barrel/endcap overlap z correction.

Definition at line 122 of file PseudoLayerPlugin.h.

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

garsoft/Pandora/GArPandora/PseudoLayerPlugin.h
garsoft/Pandora/GArPandora/PseudoLayerPlugin.cxx

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation