lar_content::LArClusterHelper Class Reference

LArClusterHelper class. More...

#include <LArClusterHelper.h>

Public Types
typedef std::set< unsigned int >	UIntSet

Static Public Member Functions
static pandora::HitType	GetClusterHitType (const pandora::Cluster *const pCluster)
	Get the hit type associated with a two dimensional cluster. More...
static void	GetClustersUVW (const pandora::ClusterList &inputClusters, pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW)
	Divide an input cluster list into separate u, v and w lists (exception raised if alternative hit type encountered) More...
static void	GetClustersByHitType (const pandora::ClusterList &inputClusters, const pandora::HitType hitType, pandora::ClusterList &clusterList)
	Get the subset of clusters, from a provided list, that match the specified hit type. More...
static float	GetLengthSquared (const pandora::Cluster *const pCluster)
	Get length squared of cluster. More...
static float	GetLength (const pandora::Cluster *const pCluster)
	Get length of cluster. More...
static float	GetEnergyFromLength (const pandora::Cluster *const pCluster)
	Get energy of cluster, based on length. More...
static unsigned int	GetLayerSpan (const pandora::Cluster *const pCluster)
	Get number of layers spanned by cluster (1+Last-First) More...
static float	GetLayerOccupancy (const pandora::Cluster *const pCluster)
	Fraction of occupied layers in cluster. More...
static float	GetLayerOccupancy (const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2)
	Fraction of occupied layers in a pair of clusters. More...
static float	GetClosestDistance (const pandora::ClusterList &clusterList1, const pandora::ClusterList &clusterList2)
	Get closest distance between clusters in a pair of cluster lists. More...
static float	GetClosestDistance (const pandora::Cluster *const pCluster, const pandora::ClusterList &clusterList)
	Get closest distance between a specified cluster and list of clusters. More...
static float	GetClosestDistance (const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2)
	Get closest distance between a pair of clusters. More...
static float	GetClosestDistance (const pandora::CartesianVector &position, const pandora::ClusterList &clusterList)
	Get closest distance between a specified position and list of clusters. More...
static float	GetClosestDistance (const pandora::CartesianVector &position, const pandora::Cluster *const pCluster)
	Get closest distance between a specified position vector and the hits in a specified cluster. More...
static float	GetClosestDistance (const pandora::CartesianVector &position, const pandora::CaloHitList &caloHitList)
	Get closest distance between a specified position vector and the hits in a specified calo hit list. More...
static pandora::CartesianVector	GetClosestPosition (const pandora::CartesianVector &position, const pandora::ClusterList &clusterList)
	Get closest position in a list of clusters to a specified input position vector. More...
static pandora::CartesianVector	GetClosestPosition (const pandora::CartesianVector &position, const pandora::Cluster *const pCluster)
	Get closest position on a cluster to a specified input position vector. More...
static pandora::CartesianVector	GetClosestPosition (const pandora::CartesianVector &position, const pandora::CaloHitList &caloHitList)
	Get closest position of hits in a given calo hit list to a specified input position vector. More...
static void	GetClosestPositions (const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2, pandora::CartesianVector &position1, pandora::CartesianVector &position2)
	Get pair of closest positions for a pair of clusters. More...
static void	GetExtremalCoordinates (const pandora::ClusterList &clusterList, pandora::CartesianVector &innerCoordinate, pandora::CartesianVector &outerCoordinate)
	Get positions of the two most distant calo hits in a list of cluster (ordered by Z) More...
static void	GetExtremalCoordinates (const pandora::Cluster *const pCluster, pandora::CartesianVector &innerCoordinate, pandora::CartesianVector &outerCoordinate)
	Get positions of the two most distant calo hits in a cluster (ordered by Z) More...
static void	GetExtremalCoordinates (const pandora::OrderedCaloHitList &orderedCaloHitList, pandora::CartesianVector &innerCoordinate, pandora::CartesianVector &outerCoordinate)
	Get positions of the two most distant calo hits in an ordered calo hit list (ordered by Z) More...
static void	GetExtremalCoordinates (const pandora::CartesianPointVector &coordinateVector, pandora::CartesianVector &innerCoordinate, pandora::CartesianVector &outerCoordinate)
	Get positions of the two most distant points in a provided list (ordered by Z) More...
static void	GetClusterBoundingBox (const pandora::Cluster *const pCluster, pandora::CartesianVector &minimumCoordinate, pandora::CartesianVector &maximumCoordinate)
	Get minimum and maximum X, Y and Z positions of the calo hits in a cluster. More...
static void	GetCoordinateVector (const pandora::Cluster *const pCluster, pandora::CartesianPointVector &coordinateVector)
	Get vector of hit coordinates from an input cluster. More...
static void	GetCaloHitListInBoundingBox (const pandora::Cluster *const pCluster, const pandora::CartesianVector &lowerBound, const pandora::CartesianVector &upperBound, pandora::CaloHitList &caloHitList)
	Get list of Calo hits from an input cluster that are contained in a bounding box. The hits are sorted by position. More...
static void	GetDaughterVolumeIDs (const pandora::Cluster *const pCluster, UIntSet &daughterVolumeIds)
	Get the set of the daughter volumes that contains the cluster. More...
static pandora::StatusCode	GetAverageZ (const pandora::Cluster *const pCluster, const float xmin, const float xmax, float &averageZ)
	Get average Z positions of the calo hits in a cluster in range xmin to xmax. More...
static bool	SortByNOccupiedLayers (const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
	Sort clusters by number of occupied layers, and by inner layer, then energy in event of a tie. More...
static bool	SortByNHits (const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
	Sort clusters by number of hits, then layer span, then inner layer, then position, then pulse-height. More...
static bool	SortByLayerSpan (const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
	Sort clusters by layer span, then inner layer, then position, then pulse-height. More...
static bool	SortByInnerLayer (const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
	Sort clusters by inner layer, then position, then pulse-height. More...
static bool	SortByPosition (const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
	Sort clusters by position, then pulse-height. More...
static bool	SortByPulseHeight (const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
	Sort clusters by pulse-height. More...
static bool	SortHitsByPosition (const pandora::CaloHit *const pLhs, const pandora::CaloHit *const pRhs)
	Sort calo hits by their position (use Z, followed by X, followed by Y) More...
static bool	SortHitsByPositionInX (const pandora::CaloHit *const pLhs, const pandora::CaloHit *const pRhs)
	Sort calo hits by their position (use X, followed by Z, followed by Y) More...
static bool	SortHitsByPulseHeight (const pandora::CaloHit *const pLhs, const pandora::CaloHit *const pRhs)
	Sort calo hits by their pulse height. More...
static bool	SortCoordinatesByPosition (const pandora::CartesianVector &lhs, const pandora::CartesianVector &rhs)
	Sort cartesian vectors by their position (use Z, followed by X, followed by Y) More...

Detailed Description

LArClusterHelper class.

Definition at line 19 of file LArClusterHelper.h.

Member Typedef Documentation

typedef std::set<unsigned int> lar_content::LArClusterHelper::UIntSet

Definition at line 22 of file LArClusterHelper.h.

Member Function Documentation

StatusCode lar_content::LArClusterHelper::GetAverageZ ( const pandora::Cluster *const  pCluster, const float  xmin, const float  xmax, float &  averageZ  )

static

Get average Z positions of the calo hits in a cluster in range xmin to xmax.

Parameters

pCluster	address of the cluster
xmin	for range in x
xmax	for range in x
averageZ	to receive the average Z position

Returns

status code, faster than throwing in regular use-cases

Definition at line 364 of file LArClusterHelper.cc.

{
    averageZ = std::numeric_limits<float>::max();

    if (xmin > xmax)
        return STATUS_CODE_INVALID_PARAMETER;

    const OrderedCaloHitList &orderedCaloHitList(pCluster->GetOrderedCaloHitList());

    float zsum(0.f);
    int count(0);

    for (OrderedCaloHitList::const_iterator ochIter = orderedCaloHitList.begin(), ochIterEnd = orderedCaloHitList.end(); ochIter != ochIterEnd; ++ochIter)
    {
        for (CaloHitList::const_iterator hIter = ochIter->second->begin(), hIterEnd = ochIter->second->end(); hIter != hIterEnd; ++hIter)
        {
            const CaloHit *const pCaloHit = *hIter;
            const CartesianVector &hit(pCaloHit->GetPositionVector());

            if (hit.GetX() < xmin || hit.GetX() > xmax)
                continue;

            zsum += hit.GetZ();
            ++count;
        }
    }

    if (count == 0)
        return STATUS_CODE_NOT_FOUND;

    averageZ = zsum / static_cast<float>(count);
    return STATUS_CODE_SUCCESS;
}

void lar_content::LArClusterHelper::GetCaloHitListInBoundingBox ( const pandora::Cluster *const  pCluster, const pandora::CartesianVector &  lowerBound, const pandora::CartesianVector &  upperBound, pandora::CaloHitList &  caloHitList  )

static

Get list of Calo hits from an input cluster that are contained in a bounding box. The hits are sorted by position.

Parameters

pCluster	address of the cluster
lowerBound	one opposing corner of the bounding box
upperBound	the other opposing corner of the bounding box
caloHitList	the CaloHitList to be filled

Definition at line 562 of file LArClusterHelper.cc.

{
    const bool useX(std::fabs(upperBound.GetX() - lowerBound.GetX()) > std::numeric_limits<float>::epsilon());
    const bool useY(std::fabs(upperBound.GetY() - lowerBound.GetY()) > std::numeric_limits<float>::epsilon());
    const bool useZ(std::fabs(upperBound.GetZ() - lowerBound.GetZ()) > std::numeric_limits<float>::epsilon());
    if (!useX && !useY && !useZ)
        throw StatusCodeException(STATUS_CODE_NOT_FOUND);

    const float minX(std::min(lowerBound.GetX(), upperBound.GetX()));
    const float maxX(std::max(lowerBound.GetX(), upperBound.GetX()));
    const float minY(std::min(lowerBound.GetY(), upperBound.GetY()));
    const float maxY(std::max(lowerBound.GetY(), upperBound.GetY()));
    const float minZ(std::min(lowerBound.GetZ(), upperBound.GetZ()));
    const float maxZ(std::max(lowerBound.GetZ(), upperBound.GetZ()));

    for (const OrderedCaloHitList::value_type &layerEntry : pCluster->GetOrderedCaloHitList())
    {
        for (const CaloHit *const pCaloHit : *layerEntry.second)
        {
            const CartesianVector &hitPosition = pCaloHit->GetPositionVector();
            if (useX && (hitPosition.GetX() < minX - std::numeric_limits<float>::epsilon() ||
                            hitPosition.GetX() > maxX + std::numeric_limits<float>::epsilon()))
                continue;
            else if (useY && (hitPosition.GetY() < minY - std::numeric_limits<float>::epsilon() ||
                                 hitPosition.GetY() > maxY + std::numeric_limits<float>::epsilon()))
                continue;
            else if (useZ && (hitPosition.GetZ() < minZ - std::numeric_limits<float>::epsilon() ||
                                 hitPosition.GetZ() > maxZ + std::numeric_limits<float>::epsilon()))
                continue;

            caloHitList.push_back(pCaloHit);
        }
    }
    caloHitList.sort(LArClusterHelper::SortHitsByPosition);
}

static float lar_content::LArClusterHelper::GetClosestDistance ( const pandora::ClusterList &  clusterList1, const pandora::ClusterList &  clusterList2  )

static

Get closest distance between clusters in a pair of cluster lists.

Parameters

clusterList1	the first cluster list
clusterList2	the second cluster list

Returns

the closest distance

static float lar_content::LArClusterHelper::GetClosestDistance ( const pandora::Cluster *const  pCluster, const pandora::ClusterList &  clusterList  )

static

Get closest distance between a specified cluster and list of clusters.

Parameters

pCluster	address of the input cluster
clusterList	list of input clusters

Returns

the closest distance

static float lar_content::LArClusterHelper::GetClosestDistance ( const pandora::Cluster *const  pCluster1, const pandora::Cluster *const  pCluster2  )

static

Get closest distance between a pair of clusters.

Parameters

pCluster1	address of the first cluster
pCluster2	address of the second cluster

Returns

the closest distance

static float lar_content::LArClusterHelper::GetClosestDistance ( const pandora::CartesianVector &  position, const pandora::ClusterList &  clusterList  )

static

Get closest distance between a specified position and list of clusters.

Parameters

position	the position vector
clusterList	list of input clusters

Returns

the closest distance

static float lar_content::LArClusterHelper::GetClosestDistance ( const pandora::CartesianVector &  position, const pandora::Cluster *const  pCluster  )

static

Get closest distance between a specified position vector and the hits in a specified cluster.

Parameters

position	the position vector
pCluster	address of the cluster

Returns

the closest distance

static float lar_content::LArClusterHelper::GetClosestDistance ( const pandora::CartesianVector &  position, const pandora::CaloHitList &  caloHitList  )

static

Get closest distance between a specified position vector and the hits in a specified calo hit list.

Parameters

position	the position vector
caloHitList	the list of calo hits

Returns

the closest distance

static pandora::CartesianVector lar_content::LArClusterHelper::GetClosestPosition ( const pandora::CartesianVector &  position, const pandora::ClusterList &  clusterList  )

static

Get closest position in a list of clusters to a specified input position vector.

Parameters

position	the position vector
clusterList	list of input clusters

Returns

the closest position

static pandora::CartesianVector lar_content::LArClusterHelper::GetClosestPosition ( const pandora::CartesianVector &  position, const pandora::Cluster *const  pCluster  )

static

Get closest position on a cluster to a specified input position vector.

Parameters

position	the position vector
pCluster	address of the cluster

Returns

the closest position

static pandora::CartesianVector lar_content::LArClusterHelper::GetClosestPosition ( const pandora::CartesianVector &  position, const pandora::CaloHitList &  caloHitList  )

static

Get closest position of hits in a given calo hit list to a specified input position vector.

Parameters

position	the position vector
caloHitList	the list of calo hits

Returns

the closest position

void lar_content::LArClusterHelper::GetClosestPositions ( const pandora::Cluster *const  pCluster1, const pandora::Cluster *const  pCluster2, pandora::CartesianVector &  position1, pandora::CartesianVector &  position2  )

static

Get pair of closest positions for a pair of clusters.

Parameters

pCluster1	the address of the first cluster
pCluster2	the address of the second cluster
the	closest position in the first cluster
the	closest position in the second cluster

Definition at line 283 of file LArClusterHelper.cc.

{
    bool distanceFound(false);
    float minDistanceSquared(std::numeric_limits<float>::max());

    CartesianVector closestPosition1(0.f, 0.f, 0.f);
    CartesianVector closestPosition2(0.f, 0.f, 0.f);

    const OrderedCaloHitList &orderedCaloHitList1(pCluster1->GetOrderedCaloHitList());
    const OrderedCaloHitList &orderedCaloHitList2(pCluster2->GetOrderedCaloHitList());

    // Loop over hits in cluster 1
    for (OrderedCaloHitList::const_iterator iter1 = orderedCaloHitList1.begin(), iter1End = orderedCaloHitList1.end(); iter1 != iter1End; ++iter1)
    {
        for (CaloHitList::const_iterator hitIter1 = iter1->second->begin(), hitIter1End = iter1->second->end(); hitIter1 != hitIter1End; ++hitIter1)
        {
            const CartesianVector &positionVector1((*hitIter1)->GetPositionVector());

            // Loop over hits in cluster 2
            for (OrderedCaloHitList::const_iterator iter2 = orderedCaloHitList2.begin(), iter2End = orderedCaloHitList2.end(); iter2 != iter2End; ++iter2)
            {
                for (CaloHitList::const_iterator hitIter2 = iter2->second->begin(), hitIter2End = iter2->second->end(); hitIter2 != hitIter2End; ++hitIter2)
                {
                    const CartesianVector &positionVector2((*hitIter2)->GetPositionVector());

                    const float distanceSquared((positionVector1 - positionVector2).GetMagnitudeSquared());

                    if (distanceSquared < minDistanceSquared)
                    {
                        minDistanceSquared = distanceSquared;
                        closestPosition1 = positionVector1;
                        closestPosition2 = positionVector2;
                        distanceFound = true;
                    }
                }
            }
        }
    }

    if (!distanceFound)
        throw StatusCodeException(STATUS_CODE_NOT_FOUND);

    outputPosition1 = closestPosition1;
    outputPosition2 = closestPosition2;
}

void lar_content::LArClusterHelper::GetClusterBoundingBox ( const pandora::Cluster *const  pCluster, pandora::CartesianVector &  minimumCoordinate, pandora::CartesianVector &  maximumCoordinate  )

static

Get minimum and maximum X, Y and Z positions of the calo hits in a cluster.

Parameters

pCluster	address of the cluster
the	minimum positions (x,y,z)
the	maximum positions (x,y,z)

Definition at line 332 of file LArClusterHelper.cc.

{
    const OrderedCaloHitList &orderedCaloHitList(pCluster->GetOrderedCaloHitList());

    float xmin(std::numeric_limits<float>::max());
    float ymin(std::numeric_limits<float>::max());
    float zmin(std::numeric_limits<float>::max());
    float xmax(-std::numeric_limits<float>::max());
    float ymax(-std::numeric_limits<float>::max());
    float zmax(-std::numeric_limits<float>::max());

    for (OrderedCaloHitList::const_iterator ochIter = orderedCaloHitList.begin(), ochIterEnd = orderedCaloHitList.end(); ochIter != ochIterEnd; ++ochIter)
    {
        for (CaloHitList::const_iterator hIter = ochIter->second->begin(), hIterEnd = ochIter->second->end(); hIter != hIterEnd; ++hIter)
        {
            const CaloHit *const pCaloHit = *hIter;
            const CartesianVector &hit(pCaloHit->GetPositionVector());
            xmin = std::min(hit.GetX(), xmin);
            xmax = std::max(hit.GetX(), xmax);
            ymin = std::min(hit.GetY(), ymin);
            ymax = std::max(hit.GetY(), ymax);
            zmin = std::min(hit.GetZ(), zmin);
            zmax = std::max(hit.GetZ(), zmax);
        }
    }

    minimumCoordinate.SetValues(xmin, ymin, zmin);
    maximumCoordinate.SetValues(xmax, ymax, zmax);
}

HitType lar_content::LArClusterHelper::GetClusterHitType ( const pandora::Cluster *const  pCluster )

static

Get the hit type associated with a two dimensional cluster.

Parameters

pCluster

the address of the cluster

Returns

the cluster hit type

Definition at line 21 of file LArClusterHelper.cc.

{
    if (0 == pCluster->GetNCaloHits())
        throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);

    // TODO Find a way of confirming single hit-type clustering mode; currently only checked in ListPreparation algorithm
    // if (!pandora->GetSettings()->SingleHitTypeClusteringMode())
    //     throw StatusCodeException(STATUS_CODE_FAILURE);

    return (*(pCluster->GetOrderedCaloHitList().begin()->second->begin()))->GetHitType();
}

void lar_content::LArClusterHelper::GetClustersByHitType ( const pandora::ClusterList &  inputClusters, const pandora::HitType  hitType, pandora::ClusterList &  clusterList  )

static

Get the subset of clusters, from a provided list, that match the specified hit type.

Parameters

inputClusters	the input cluster list
hitType	the specified hit type
clusterList	to receive the clusters

Definition at line 54 of file LArClusterHelper.cc.

{
    for (ClusterList::const_iterator iter = inputClusters.begin(), iterEnd = inputClusters.end(); iter != iterEnd; ++iter)
    {
        if (hitType == LArClusterHelper::GetClusterHitType(*iter))
            clusterList.push_back(*iter);
    }
}

void lar_content::LArClusterHelper::GetClustersUVW ( const pandora::ClusterList &  inputClusters, pandora::ClusterList &  clusterListU, pandora::ClusterList &  clusterListV, pandora::ClusterList &  clusterListW  )

static

Divide an input cluster list into separate u, v and w lists (exception raised if alternative hit type encountered)

Parameters

inputClusters	the input cluster list
clusterListU	to receive the u clusters
clusterListV	to receive the v clusters
clusterListW	to receive the w clusters

Definition at line 35 of file LArClusterHelper.cc.

{
    for (ClusterList::const_iterator iter = inputClusters.begin(), iterEnd = inputClusters.end(); iter != iterEnd; ++iter)
    {
        const HitType hitType(LArClusterHelper::GetClusterHitType(*iter));

        if (TPC_VIEW_U == hitType)
            clusterListU.push_back(*iter);
        else if (TPC_VIEW_V == hitType)
            clusterListV.push_back(*iter);
        else if (TPC_VIEW_W == hitType)
            clusterListW.push_back(*iter);
        else
            throw StatusCodeException(STATUS_CODE_NOT_FOUND);
    }
}

void lar_content::LArClusterHelper::GetCoordinateVector ( const pandora::Cluster *const  pCluster, pandora::CartesianPointVector &  coordinateVector  )

static

Get vector of hit coordinates from an input cluster.

Parameters

pCluster	address of the cluster
coordinateVector

Definition at line 549 of file LArClusterHelper.cc.

{
    for (const OrderedCaloHitList::value_type &layerEntry : pCluster->GetOrderedCaloHitList())
    {
        for (const CaloHit *const pCaloHit : *layerEntry.second)
            coordinateVector.push_back(pCaloHit->GetPositionVector());
    }

    std::sort(coordinateVector.begin(), coordinateVector.end(), LArClusterHelper::SortCoordinatesByPosition);
}

void lar_content::LArClusterHelper::GetDaughterVolumeIDs ( const pandora::Cluster *const  pCluster, UIntSet &  daughterVolumeIds  )

static

Get the set of the daughter volumes that contains the cluster.

Parameters

pCluster	address of the cluster
daughterVolumeIds	output variable

Definition at line 601 of file LArClusterHelper.cc.

{
    const OrderedCaloHitList &orderedCaloHitList(pCluster->GetOrderedCaloHitList());

    for (OrderedCaloHitList::const_iterator ochIter = orderedCaloHitList.begin(), ochIterEnd = orderedCaloHitList.end(); ochIter != ochIterEnd; ++ochIter)
    {
        for (CaloHitList::const_iterator hIter = ochIter->second->begin(), hIterEnd = ochIter->second->end(); hIter != hIterEnd; ++hIter)
        {
            const CaloHit *const pCaloHit(*hIter);
            const LArCaloHit *const pLArCaloHit(dynamic_cast<const LArCaloHit *>(pCaloHit));

            if (pLArCaloHit)
                daughterVolumeIds.insert(pLArCaloHit->GetDaughterVolumeId());
        }
    }
}

float lar_content::LArClusterHelper::GetEnergyFromLength ( const pandora::Cluster *const  pCluster )

static

Get energy of cluster, based on length.

Parameters

pCluster

address of the cluster

Returns

the energy

Definition at line 104 of file LArClusterHelper.cc.

{
    const float dEdX(0.002f); // approximately 2 MeV/cm
    return (dEdX * LArClusterHelper::GetLength(pCluster));
}

static void lar_content::LArClusterHelper::GetExtremalCoordinates ( const pandora::ClusterList &  clusterList, pandora::CartesianVector &  innerCoordinate, pandora::CartesianVector &  outerCoordinate  )

static

Get positions of the two most distant calo hits in a list of cluster (ordered by Z)

Parameters

clusterList	the input cluster list
the	inner extremal position
the	outer extremal position

static void lar_content::LArClusterHelper::GetExtremalCoordinates ( const pandora::Cluster *const  pCluster, pandora::CartesianVector &  innerCoordinate, pandora::CartesianVector &  outerCoordinate  )

static

Get positions of the two most distant calo hits in a cluster (ordered by Z)

Parameters

pCluster	the input cluster
the	inner extremal position
the	outer extremal position

static void lar_content::LArClusterHelper::GetExtremalCoordinates ( const pandora::OrderedCaloHitList &  orderedCaloHitList, pandora::CartesianVector &  innerCoordinate, pandora::CartesianVector &  outerCoordinate  )

static

Get positions of the two most distant calo hits in an ordered calo hit list (ordered by Z)

Parameters

orderedCaloHitList	the ordered calo hit list
the	inner extremal position
the	outer extremal position

static void lar_content::LArClusterHelper::GetExtremalCoordinates ( const pandora::CartesianPointVector &  coordinateVector, pandora::CartesianVector &  innerCoordinate, pandora::CartesianVector &  outerCoordinate  )

static

Get positions of the two most distant points in a provided list (ordered by Z)

Parameters

coordinateVector	the hit list
the	inner extremal position
the	outer extremal position

static float lar_content::LArClusterHelper::GetLayerOccupancy ( const pandora::Cluster *const  pCluster )

static

Fraction of occupied layers in cluster.

Parameters

pCluster

address of the cluster

Returns

float

static float lar_content::LArClusterHelper::GetLayerOccupancy ( const pandora::Cluster *const  pCluster1, const pandora::Cluster *const  pCluster2  )

static

Fraction of occupied layers in a pair of clusters.

Parameters

pCluster1	address of the first cluster
pCluster2	address of the second cluster

Returns

float

unsigned int lar_content::LArClusterHelper::GetLayerSpan ( const pandora::Cluster *const  pCluster )

static

Get number of layers spanned by cluster (1+Last-First)

Parameters

pCluster

address of the cluster

Returns

the layer span

Definition at line 112 of file LArClusterHelper.cc.

{
    return (1 + pCluster->GetOuterPseudoLayer() - pCluster->GetInnerPseudoLayer());
}

float lar_content::LArClusterHelper::GetLength ( const pandora::Cluster *const  pCluster )

static

Get length of cluster.

Parameters

pCluster

address of the cluster

Returns

the length

Definition at line 97 of file LArClusterHelper.cc.

{
    return std::sqrt(LArClusterHelper::GetLengthSquared(pCluster));
}

float lar_content::LArClusterHelper::GetLengthSquared ( const pandora::Cluster *const  pCluster )

static

Get length squared of cluster.

Parameters

pCluster

address of the cluster

Returns

the length squared

Definition at line 65 of file LArClusterHelper.cc.

{
    const OrderedCaloHitList &orderedCaloHitList(pCluster->GetOrderedCaloHitList());

    if (orderedCaloHitList.empty())
        throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);

    // ATTN In 2D case, we will actually calculate the quadrature sum of deltaX and deltaU/V/W
    float minX(std::numeric_limits<float>::max()), maxX(-std::numeric_limits<float>::max());
    float minY(std::numeric_limits<float>::max()), maxY(-std::numeric_limits<float>::max());
    float minZ(std::numeric_limits<float>::max()), maxZ(-std::numeric_limits<float>::max());

    for (OrderedCaloHitList::const_iterator iter = orderedCaloHitList.begin(), iterEnd = orderedCaloHitList.end(); iter != iterEnd; ++iter)
    {
        for (CaloHitList::const_iterator hitIter = iter->second->begin(), hitIterEnd = iter->second->end(); hitIter != hitIterEnd; ++hitIter)
        {
            const CartesianVector &hitPosition((*hitIter)->GetPositionVector());
            minX = std::min(hitPosition.GetX(), minX);
            maxX = std::max(hitPosition.GetX(), maxX);
            minY = std::min(hitPosition.GetY(), minY);
            maxY = std::max(hitPosition.GetY(), maxY);
            minZ = std::min(hitPosition.GetZ(), minZ);
            maxZ = std::max(hitPosition.GetZ(), maxZ);
        }
    }

    const float deltaX(maxX - minX), deltaY(maxY - minY), deltaZ(maxZ - minZ);
    return (deltaX * deltaX + deltaY * deltaY + deltaZ * deltaZ);
}

bool lar_content::LArClusterHelper::SortByInnerLayer ( const pandora::Cluster *const  pLhs, const pandora::Cluster *const  pRhs  )

static

Sort clusters by inner layer, then position, then pulse-height.

Parameters

pLhs	address of first cluster
pRhs	address of second cluster

Definition at line 658 of file LArClusterHelper.cc.

{
    const unsigned int innerLayerLhs(pLhs->GetInnerPseudoLayer());
    const unsigned int innerLayerRhs(pRhs->GetInnerPseudoLayer());

    if (innerLayerLhs != innerLayerRhs)
        return (innerLayerLhs < innerLayerRhs);

    return SortByPosition(pLhs, pRhs);
}

bool lar_content::LArClusterHelper::SortByLayerSpan ( const pandora::Cluster *const  pLhs, const pandora::Cluster *const  pRhs  )

static

Sort clusters by layer span, then inner layer, then position, then pulse-height.

Parameters

pLhs	address of first cluster
pRhs	address of second cluster

Definition at line 645 of file LArClusterHelper.cc.

{
    const unsigned int layerSpanLhs(pLhs->GetOuterPseudoLayer() - pLhs->GetInnerPseudoLayer());
    const unsigned int layerSpanRhs(pRhs->GetOuterPseudoLayer() - pRhs->GetInnerPseudoLayer());

    if (layerSpanLhs != layerSpanRhs)
        return (layerSpanLhs > layerSpanRhs);

    return SortByInnerLayer(pLhs, pRhs);
}

bool lar_content::LArClusterHelper::SortByNHits ( const pandora::Cluster *const  pLhs, const pandora::Cluster *const  pRhs  )

static

Sort clusters by number of hits, then layer span, then inner layer, then position, then pulse-height.

Parameters

pLhs	address of first cluster
pRhs	address of second cluster

Definition at line 632 of file LArClusterHelper.cc.

{
    const unsigned int nHitsLhs(pLhs->GetNCaloHits());
    const unsigned int nHitsRhs(pRhs->GetNCaloHits());

    if (nHitsLhs != nHitsRhs)
        return (nHitsLhs > nHitsRhs);

    return SortByLayerSpan(pLhs, pRhs);
}

bool lar_content::LArClusterHelper::SortByNOccupiedLayers ( const pandora::Cluster *const  pLhs, const pandora::Cluster *const  pRhs  )

static

Sort clusters by number of occupied layers, and by inner layer, then energy in event of a tie.

Parameters

pLhs	address of first cluster
pRhs	address of second cluster

Definition at line 619 of file LArClusterHelper.cc.

{
    const unsigned int nOccupiedLayersLhs(pLhs->GetOrderedCaloHitList().size());
    const unsigned int nOccupiedLayersRhs(pRhs->GetOrderedCaloHitList().size());

    if (nOccupiedLayersLhs != nOccupiedLayersRhs)
        return (nOccupiedLayersLhs > nOccupiedLayersRhs);

    return SortByNHits(pLhs, pRhs);
}

bool lar_content::LArClusterHelper::SortByPosition ( const pandora::Cluster *const  pLhs, const pandora::Cluster *const  pRhs  )

static

Sort clusters by position, then pulse-height.

Parameters

pLhs	address of first cluster
pRhs	address of second cluster

Definition at line 671 of file LArClusterHelper.cc.

{
    const CartesianVector deltaPositionIL(pRhs->GetCentroid(pRhs->GetInnerPseudoLayer()) - pLhs->GetCentroid(pLhs->GetInnerPseudoLayer()));

    if (std::fabs(deltaPositionIL.GetZ()) > std::numeric_limits<float>::epsilon())
        return (deltaPositionIL.GetZ() > std::numeric_limits<float>::epsilon());

    if (std::fabs(deltaPositionIL.GetX()) > std::numeric_limits<float>::epsilon())
        return (deltaPositionIL.GetX() > std::numeric_limits<float>::epsilon());

    if (std::fabs(deltaPositionIL.GetY()) > std::numeric_limits<float>::epsilon())
        return (deltaPositionIL.GetY() > std::numeric_limits<float>::epsilon());

    const CartesianVector deltaPositionOL(pRhs->GetCentroid(pRhs->GetOuterPseudoLayer()) - pLhs->GetCentroid(pLhs->GetOuterPseudoLayer()));

    if (std::fabs(deltaPositionOL.GetZ()) > std::numeric_limits<float>::epsilon())
        return (deltaPositionOL.GetZ() > std::numeric_limits<float>::epsilon());

    if (std::fabs(deltaPositionOL.GetX()) > std::numeric_limits<float>::epsilon())
        return (deltaPositionOL.GetX() > std::numeric_limits<float>::epsilon());

    if (std::fabs(deltaPositionOL.GetY()) > std::numeric_limits<float>::epsilon())
        return (deltaPositionOL.GetY() > std::numeric_limits<float>::epsilon());

    // Use pulse height to resolve ties
    return SortByPulseHeight(pLhs, pRhs);
}

bool lar_content::LArClusterHelper::SortByPulseHeight ( const pandora::Cluster *const  pLhs, const pandora::Cluster *const  pRhs  )

static

Sort clusters by pulse-height.

Parameters

pLhs	address of first cluster
pRhs	address of second cluster

Definition at line 701 of file LArClusterHelper.cc.

{
    return (pLhs->GetHadronicEnergy() > pRhs->GetHadronicEnergy());
}

bool lar_content::LArClusterHelper::SortCoordinatesByPosition ( const pandora::CartesianVector &  lhs, const pandora::CartesianVector &  rhs  )

static

Sort cartesian vectors by their position (use Z, followed by X, followed by Y)

Parameters

lhs	first point
rhs	second point

Definition at line 747 of file LArClusterHelper.cc.

{
    const CartesianVector deltaPosition(rhs - lhs);

    if (std::fabs(deltaPosition.GetZ()) > std::numeric_limits<float>::epsilon())
        return (deltaPosition.GetZ() > std::numeric_limits<float>::epsilon());

    if (std::fabs(deltaPosition.GetX()) > std::numeric_limits<float>::epsilon())
        return (deltaPosition.GetX() > std::numeric_limits<float>::epsilon());

    return (deltaPosition.GetY() > std::numeric_limits<float>::epsilon());
}

bool lar_content::LArClusterHelper::SortHitsByPosition ( const pandora::CaloHit *const  pLhs, const pandora::CaloHit *const  pRhs  )

static

Sort calo hits by their position (use Z, followed by X, followed by Y)

Parameters

pLhs	address of first calo hit
pRhs	address of second calo hit

Definition at line 708 of file LArClusterHelper.cc.

{
    const CartesianVector deltaPosition(pRhs->GetPositionVector() - pLhs->GetPositionVector());

    if (std::fabs(deltaPosition.GetZ()) > std::numeric_limits<float>::epsilon())
        return (deltaPosition.GetZ() > std::numeric_limits<float>::epsilon());

    if (std::fabs(deltaPosition.GetX()) > std::numeric_limits<float>::epsilon())
        return (deltaPosition.GetX() > std::numeric_limits<float>::epsilon());

    if (std::fabs(deltaPosition.GetY()) > std::numeric_limits<float>::epsilon())
        return (deltaPosition.GetY() > std::numeric_limits<float>::epsilon());

    // Use pulse height to resolve ties
    return SortHitsByPulseHeight(pLhs, pRhs);
}

bool lar_content::LArClusterHelper::SortHitsByPositionInX ( const pandora::CaloHit *const  pLhs, const pandora::CaloHit *const  pRhs  )

static

Sort calo hits by their position (use X, followed by Z, followed by Y)

Parameters

pLhs	address of first calo hit
pRhs	address of second calo hit

Definition at line 727 of file LArClusterHelper.cc.

{
    const CartesianVector deltaPosition(pRhs->GetPositionVector() - pLhs->GetPositionVector());

    if (std::fabs(deltaPosition.GetX()) > std::numeric_limits<float>::epsilon())
        return (deltaPosition.GetX() > std::numeric_limits<float>::epsilon());

    return SortHitsByPosition(pLhs, pRhs);
}

bool lar_content::LArClusterHelper::SortHitsByPulseHeight ( const pandora::CaloHit *const  pLhs, const pandora::CaloHit *const  pRhs  )

static

Sort calo hits by their pulse height.

Parameters

pLhs	address of first calo hit
pRhs	address of second calo hit

Definition at line 739 of file LArClusterHelper.cc.

{
    // TODO: Think about the correct energy to use here (should they ever be different)
    return (pLhs->GetHadronicEnergy() > pRhs->GetHadronicEnergy());
}

---

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

• larpandoracontent/larpandoracontent/LArHelpers/LArClusterHelper.h
• larpandoracontent/larpandoracontent/LArHelpers/LArClusterHelper.cc