lar_content::BeamParticleIdTool Class Reference

BeamParticleIdTool class. More...

#include <BeamParticleIdTool.h>

Inheritance diagram for lar_content::BeamParticleIdTool:

Classes
class	Plane
	Plane class. More...

Public Member Functions
	BeamParticleIdTool ()
	Default constructor. More...
void	SelectOutputPfos (const pandora::Algorithm *const pAlgorithm, const SliceHypotheses &beamSliceHypotheses, const SliceHypotheses &crSliceHypotheses, pandora::PfoList &selectedPfos)
	Select which reconstruction hypotheses to use; neutrino outcomes or cosmic-ray muon outcomes for each slice. More...

Private Types
typedef std::vector< Plane >	PlaneVector

Private Member Functions
pandora::StatusCode	Initialize ()
void	GetSelectedCaloHits (const pandora::CaloHitList &inputCaloHitList, pandora::CaloHitList &outputCaloHitList, float &closestHitToFaceDistance) const
	Select a given fraction of a slice's calo hits that are closest to the beam spot. More...
void	GetTPCIntercepts (const pandora::CartesianVector &a0, const pandora::CartesianVector &majorAxis, pandora::CartesianVector &interceptOne, pandora::CartesianVector &interceptTwo) const
	Find the intercepts of a line with the protoDUNE detector. More...
bool	IsContained (const pandora::CartesianVector &spacePoint) const
	Check if a given 3D spacepoint is inside the global TPC volume. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
bool	m_selectAllBeamParticles
	First approach: select all beam particles, as opposed to selecting all cosmics. More...
bool	m_selectOnlyFirstSliceBeamParticles
	First approach: select first slice beam particles, cosmics for all subsequent slices. More...
float	m_tpcMinX
	Global TPC volume minimum x extent. More...
float	m_tpcMaxX
	Global TPC volume maximum x extent. More...
float	m_tpcMinY
	Global TPC volume minimum y extent. More...
float	m_tpcMaxY
	Global TPC volume maximum y extent. More...
float	m_tpcMinZ
	Global TPC volume minimum z extent. More...
float	m_tpcMaxZ
	Global TPC volume maximum z extent. More...
pandora::CartesianVector	m_beamTPCIntersection
	Intersection of beam and global TPC volume. More...
pandora::CartesianVector	m_beamDirection
	Beam direction. More...
PlaneVector	m_tpcPlanes
	Vector of all planes making up global TPC volume. More...
float	m_projectionIntersectionCut
	Projection intersection distance cut, used in beam event selection. More...
float	m_closestDistanceCut
	Closest distance (of hit to beam spot), used in beam event selection. More...
float	m_angleToBeamCut
	Angle between major axis and beam direction, used in beam event selection. More...
float	m_selectedFraction
	Fraction of hits to use in 3D cluster fits. More...
unsigned int	m_nSelectedHits
	Minimum number of hits to use in 3D cluster fits. More...

Detailed Description

BeamParticleIdTool class.

Definition at line 19 of file BeamParticleIdTool.h.

Member Typedef Documentation

typedef std::vector<Plane> lar_content::BeamParticleIdTool::PlaneVector

private

Definition at line 90 of file BeamParticleIdTool.h.

Constructor & Destructor Documentation

lar_content::BeamParticleIdTool::BeamParticleIdTool

(

)

Default constructor.

Definition at line 21 of file BeamParticleIdTool.cc.

                                       :
    m_selectAllBeamParticles(false),
    m_selectOnlyFirstSliceBeamParticles(false),
    m_tpcMinX(std::numeric_limits<float>::max()),
    m_tpcMaxX(-std::numeric_limits<float>::max()),
    m_tpcMinY(std::numeric_limits<float>::max()),
    m_tpcMaxY(-std::numeric_limits<float>::max()),
    m_tpcMinZ(std::numeric_limits<float>::max()),
    m_tpcMaxZ(-std::numeric_limits<float>::max()),
    m_beamTPCIntersection(0.f, 0.f, 0.f),
    m_beamDirection(0.f, 0.f, 0.f),
    m_projectionIntersectionCut(100.f),
    m_closestDistanceCut(100.f),
    m_angleToBeamCut(150.f * M_PI / 180.f),
    m_selectedFraction(10.f),
    m_nSelectedHits(100)
{
}

Member Function Documentation

void lar_content::BeamParticleIdTool::GetSelectedCaloHits ( const pandora::CaloHitList &  inputCaloHitList, pandora::CaloHitList &  outputCaloHitList, float &  closestHitToFaceDistance  ) const

private

Select a given fraction of a slice's calo hits that are closest to the beam spot.

Parameters

inputCaloHitList	all calo hits in slice
outputCaloHitList	to receive the list of selected calo hits
closestHitToFaceDistance	to receive the distance of closest hit to beam spot

Definition at line 180 of file BeamParticleIdTool.cc.

{
    if (inputCaloHitList.empty())
        throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);

    typedef std::pair<const CaloHit *, float> HitDistancePair;
    typedef std::vector<HitDistancePair> HitDistanceVector;
    HitDistanceVector hitDistanceVector;

    for (const CaloHit *const pCaloHit : inputCaloHitList)
        hitDistanceVector.emplace_back(pCaloHit, (pCaloHit->GetPositionVector() - m_beamTPCIntersection).GetMagnitudeSquared());

    std::sort(hitDistanceVector.begin(), hitDistanceVector.end(),
        [](const HitDistancePair &lhs, const HitDistancePair &rhs) -> bool { return (lhs.second < rhs.second); });
    closestHitToFaceDistance = std::sqrt(hitDistanceVector.front().second);

    const unsigned int nInputHits(inputCaloHitList.size());
    const unsigned int nSelectedCaloHits(
        nInputHits < m_nSelectedHits ? nInputHits
                                     : static_cast<unsigned int>(std::round(static_cast<float>(nInputHits) * m_selectedFraction / 100.f + 0.5f)));

    for (const HitDistancePair &hitDistancePair : hitDistanceVector)
    {
        outputCaloHitList.push_back(hitDistancePair.first);

        if (outputCaloHitList.size() >= nSelectedCaloHits)
            break;
    }
}

void lar_content::BeamParticleIdTool::GetTPCIntercepts ( const pandora::CartesianVector &  a0, const pandora::CartesianVector &  majorAxis, pandora::CartesianVector &  interceptOne, pandora::CartesianVector &  interceptTwo  ) const

private

Find the intercepts of a line with the protoDUNE detector.

Parameters

a0	a point on the line in question
majorAxis	the direction of the line in question
interceptOne	to receive the first intersection between line and protoDUNE detector
interceptTwo	to receive the second intersection between line and protoDUNE detector

Definition at line 212 of file BeamParticleIdTool.cc.

{
    CartesianPointVector intercepts;
    const CartesianVector lineUnitVector(lineDirection.GetUnitVector());

    for (const Plane &plane : m_tpcPlanes)
    {
        const CartesianVector intercept(plane.GetLineIntersection(a0, lineUnitVector));

        if (this->IsContained(intercept))
            intercepts.push_back(intercept);
    }

    if (intercepts.size() == 2)
    {
        interceptOne = intercepts.at(0);
        interceptTwo = intercepts.at(1);
    }
    else
    {
        throw StatusCodeException(STATUS_CODE_NOT_ALLOWED);
    }
}

StatusCode lar_content::BeamParticleIdTool::Initialize ( )

private

Definition at line 133 of file BeamParticleIdTool.cc.

{
    // Get global TPC geometry information
    const LArTPCMap &larTPCMap(this->GetPandora().GetGeometry()->GetLArTPCMap());
    const LArTPC *const pFirstLArTPC(larTPCMap.begin()->second);
    float parentMinX(pFirstLArTPC->GetCenterX() - 0.5f * pFirstLArTPC->GetWidthX());
    float parentMaxX(pFirstLArTPC->GetCenterX() + 0.5f * pFirstLArTPC->GetWidthX());
    float parentMinY(pFirstLArTPC->GetCenterY() - 0.5f * pFirstLArTPC->GetWidthY());
    float parentMaxY(pFirstLArTPC->GetCenterY() + 0.5f * pFirstLArTPC->GetWidthY());
    float parentMinZ(pFirstLArTPC->GetCenterZ() - 0.5f * pFirstLArTPC->GetWidthZ());
    float parentMaxZ(pFirstLArTPC->GetCenterZ() + 0.5f * pFirstLArTPC->GetWidthZ());

    for (const LArTPCMap::value_type &mapEntry : larTPCMap)
    {
        const LArTPC *const pLArTPC(mapEntry.second);
        parentMinX = std::min(parentMinX, pLArTPC->GetCenterX() - 0.5f * pLArTPC->GetWidthX());
        parentMaxX = std::max(parentMaxX, pLArTPC->GetCenterX() + 0.5f * pLArTPC->GetWidthX());
        parentMinY = std::min(parentMinY, pLArTPC->GetCenterY() - 0.5f * pLArTPC->GetWidthY());
        parentMaxY = std::max(parentMaxY, pLArTPC->GetCenterY() + 0.5f * pLArTPC->GetWidthY());
        parentMinZ = std::min(parentMinZ, pLArTPC->GetCenterZ() - 0.5f * pLArTPC->GetWidthZ());
        parentMaxZ = std::max(parentMaxZ, pLArTPC->GetCenterZ() + 0.5f * pLArTPC->GetWidthZ());
    }
    m_tpcMinX = parentMinX;
    m_tpcMaxX = parentMaxX;
    m_tpcMinY = parentMinY;
    m_tpcMaxY = parentMaxY;
    m_tpcMinZ = parentMinZ;
    m_tpcMaxZ = parentMaxZ;

    const CartesianVector normalTop(0.f, 0.f, 1.f), pointTop(0.f, 0.f, m_tpcMaxZ);
    const CartesianVector normalBottom(0.f, 0.f, -1.f), pointBottom(0.f, 0.f, m_tpcMinZ);
    const CartesianVector normalRight(1.f, 0.f, 0.f), pointRight(m_tpcMaxX, 0.f, 0.f);
    const CartesianVector normalLeft(-1.f, 0.f, 0.f), pointLeft(m_tpcMinX, 0.f, 0.f);
    const CartesianVector normalBack(0.f, 1.f, 0.f), pointBack(0.f, m_tpcMaxY, 0.f);
    const CartesianVector normalFront(0.f, -1.f, 0.f), pointFront(0.f, m_tpcMinY, 0.f);
    m_tpcPlanes.emplace_back(normalTop, pointTop);
    m_tpcPlanes.emplace_back(normalBottom, pointBottom);
    m_tpcPlanes.emplace_back(normalRight, pointRight);
    m_tpcPlanes.emplace_back(normalLeft, pointLeft);
    m_tpcPlanes.emplace_back(normalBack, pointBack);
    m_tpcPlanes.emplace_back(normalFront, pointFront);

    return STATUS_CODE_SUCCESS;
}

bool lar_content::BeamParticleIdTool::IsContained ( const pandora::CartesianVector &  spacePoint ) const

private

Check if a given 3D spacepoint is inside the global TPC volume.

Parameters

spacePoint

Definition at line 239 of file BeamParticleIdTool.cc.

{
    if ((m_tpcMinX - spacePoint.GetX() > std::numeric_limits<float>::epsilon()) ||
        (spacePoint.GetX() - m_tpcMaxX > std::numeric_limits<float>::epsilon()) ||
        (m_tpcMinY - spacePoint.GetY() > std::numeric_limits<float>::epsilon()) ||
        (spacePoint.GetY() - m_tpcMaxY > std::numeric_limits<float>::epsilon()) ||
        (m_tpcMinZ - spacePoint.GetZ() > std::numeric_limits<float>::epsilon()) ||
        (spacePoint.GetZ() - m_tpcMaxZ > std::numeric_limits<float>::epsilon()))
    {
        return false;
    }

    return true;
}

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

private

Definition at line 283 of file BeamParticleIdTool.cc.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SelectAllBeamParticles", m_selectAllBeamParticles));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "SelectOnlyFirstSliceBeamParticles", m_selectOnlyFirstSliceBeamParticles));

    if (m_selectAllBeamParticles && m_selectOnlyFirstSliceBeamParticles)
    {
        std::cout << "BeamParticleIdTool::ReadSettings - cannot use both SelectAllBeamParticles and SelectOnlyFirstSliceBeamParticles simultaneously"
                  << std::endl;
        return STATUS_CODE_INVALID_PARAMETER;
    }

    FloatVector beamTPCIntersection;
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadVectorOfValues(xmlHandle, "BeamTPCIntersection", beamTPCIntersection));

    if (3 == beamTPCIntersection.size())
    {
        m_beamTPCIntersection.SetValues(beamTPCIntersection.at(0), beamTPCIntersection.at(1), beamTPCIntersection.at(2));
    }
    else if (!beamTPCIntersection.empty())
    {
        std::cout << "BeamParticleIdTool::ReadSettings - invalid BeamTPCIntersection specified " << std::endl;
        return STATUS_CODE_INVALID_PARAMETER;
    }
    else
    {
        // Default for protoDUNE.
        m_beamTPCIntersection.SetValues(-33.051, 461.06, 0);
    }

    FloatVector beamDirection;
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "BeamDirection", beamDirection));

    if (3 == beamDirection.size())
    {
        m_beamDirection.SetValues(beamDirection.at(0), beamDirection.at(1), beamDirection.at(2));
    }
    else if (!beamDirection.empty())
    {
        std::cout << "BeamParticleIdTool::ReadSettings - invalid BeamDirection specified " << std::endl;
        return STATUS_CODE_INVALID_PARAMETER;
    }
    else
    {
        // Default for protoDUNE.
        const float thetaXZ0(-11.844f * M_PI / 180.f);
        m_beamDirection.SetValues(std::sin(thetaXZ0), 0, std::cos(thetaXZ0));
    }

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "ProjectionIntersectionCut", m_projectionIntersectionCut));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ClosestDistanceCut", m_closestDistanceCut));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "AngleToBeamCut", m_angleToBeamCut));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SelectedFraction", m_selectedFraction));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NSelectedHits", m_nSelectedHits));

    return STATUS_CODE_SUCCESS;
}

void lar_content::BeamParticleIdTool::SelectOutputPfos ( const pandora::Algorithm *const  pAlgorithm, const SliceHypotheses &  nuSliceHypotheses, const SliceHypotheses &  crSliceHypotheses, pandora::PfoList &  selectedPfos  )

virtual

Select which reconstruction hypotheses to use; neutrino outcomes or cosmic-ray muon outcomes for each slice.

Parameters

pAlgorithm	the address of the master instance, used to access MCParticles when in training mode
nuSliceHypotheses	the parent pfos representing the neutrino outcome for each slice
crSliceHypotheses	the parent pfos representing the cosmic-ray muon outcome for each slice
sliceNuPfos	to receive the list of selected pfos

Implements lar_content::SliceIdBaseTool.

Definition at line 42 of file BeamParticleIdTool.cc.

{
    if (beamSliceHypotheses.size() != crSliceHypotheses.size())
        throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);

    // First, simple approach
    if (m_selectAllBeamParticles || m_selectOnlyFirstSliceBeamParticles)
    {
        for (unsigned int sliceIndex = 0, nSlices = beamSliceHypotheses.size(); sliceIndex < nSlices; ++sliceIndex)
        {
            const PfoList &sliceOutput((m_selectAllBeamParticles || (m_selectOnlyFirstSliceBeamParticles && (0 == sliceIndex)))
                                           ? beamSliceHypotheses.at(sliceIndex)
                                           : crSliceHypotheses.at(sliceIndex));

            const float score(m_selectAllBeamParticles || (m_selectOnlyFirstSliceBeamParticles && (0 == sliceIndex)) ? 1.f : -1.f);

            for (const ParticleFlowObject *const pPfo : sliceOutput)
            {
                object_creation::ParticleFlowObject::Metadata metadata;
                metadata.m_propertiesToAdd["TestBeamScore"] = score;
                PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::AlterMetadata(*pAlgorithm, pPfo, metadata));
            }

            selectedPfos.insert(selectedPfos.end(), sliceOutput.begin(), sliceOutput.end());
        }

        return;
    }

    // Now start to examine topology of beam slice hypotheses
    for (unsigned int sliceIndex = 0, nSlices = beamSliceHypotheses.size(); sliceIndex < nSlices; ++sliceIndex)
    {
        bool usebeamHypothesis(false);

        try
        {
            PfoList allConnectedPfoList;
            LArPfoHelper::GetAllConnectedPfos(beamSliceHypotheses.at(sliceIndex), allConnectedPfoList);

            CaloHitList caloHitList3D;
            LArPfoHelper::GetCaloHits(allConnectedPfoList, TPC_3D, caloHitList3D);

            CaloHitList selectedCaloHitList;
            float closestDistance(std::numeric_limits<float>::max());
            this->GetSelectedCaloHits(caloHitList3D, selectedCaloHitList, closestDistance);

            if (!selectedCaloHitList.empty())
            {
                CartesianVector centroidSel(0.f, 0.f, 0.f);
                LArPcaHelper::EigenVectors eigenVecsSel;
                LArPcaHelper::EigenValues eigenValuesSel(0.f, 0.f, 0.f);
                LArPcaHelper::RunPca(selectedCaloHitList, centroidSel, eigenValuesSel, eigenVecsSel);

                const CartesianVector &majorAxisSel(eigenVecsSel.front());
                const float supplementaryAngleToBeam(majorAxisSel.GetOpeningAngle(m_beamDirection));

                CartesianVector interceptOne(0.f, 0.f, 0.f), interceptTwo(0.f, 0.f, 0.f);
                this->GetTPCIntercepts(centroidSel, majorAxisSel, interceptOne, interceptTwo);

                const float separationOne((interceptOne - m_beamTPCIntersection).GetMagnitude());
                const float separationTwo((interceptTwo - m_beamTPCIntersection).GetMagnitude());

                if ((std::min(separationOne, separationTwo) < m_projectionIntersectionCut) && (closestDistance < m_closestDistanceCut) &&
                    (supplementaryAngleToBeam > m_angleToBeamCut))
                {
                    usebeamHypothesis = true;
                }
            }
        }
        catch (const StatusCodeException &)
        {
            usebeamHypothesis = false;
        }

        const PfoList &sliceOutput(usebeamHypothesis ? beamSliceHypotheses.at(sliceIndex) : crSliceHypotheses.at(sliceIndex));
        selectedPfos.insert(selectedPfos.end(), sliceOutput.begin(), sliceOutput.end());

        const float score(usebeamHypothesis ? 1.f : -1.f);

        for (const ParticleFlowObject *const pPfo : sliceOutput)
        {
            object_creation::ParticleFlowObject::Metadata metadata;
            metadata.m_propertiesToAdd["TestBeamScore"] = score;
            PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::AlterMetadata(*pAlgorithm, pPfo, metadata));
        }
    }
}

Member Data Documentation

float lar_content::BeamParticleIdTool::m_angleToBeamCut

private

Angle between major axis and beam direction, used in beam event selection.

Definition at line 106 of file BeamParticleIdTool.h.

pandora::CartesianVector lar_content::BeamParticleIdTool::m_beamDirection

private

Beam direction.

Definition at line 101 of file BeamParticleIdTool.h.

pandora::CartesianVector lar_content::BeamParticleIdTool::m_beamTPCIntersection

private

Intersection of beam and global TPC volume.

Definition at line 100 of file BeamParticleIdTool.h.

float lar_content::BeamParticleIdTool::m_closestDistanceCut

private

Closest distance (of hit to beam spot), used in beam event selection.

Definition at line 105 of file BeamParticleIdTool.h.

unsigned int lar_content::BeamParticleIdTool::m_nSelectedHits

private

Minimum number of hits to use in 3D cluster fits.

Definition at line 108 of file BeamParticleIdTool.h.

float lar_content::BeamParticleIdTool::m_projectionIntersectionCut

private

Projection intersection distance cut, used in beam event selection.

Definition at line 104 of file BeamParticleIdTool.h.

bool lar_content::BeamParticleIdTool::m_selectAllBeamParticles

private

First approach: select all beam particles, as opposed to selecting all cosmics.

Definition at line 92 of file BeamParticleIdTool.h.

float lar_content::BeamParticleIdTool::m_selectedFraction

private

Fraction of hits to use in 3D cluster fits.

Definition at line 107 of file BeamParticleIdTool.h.

bool lar_content::BeamParticleIdTool::m_selectOnlyFirstSliceBeamParticles

private

First approach: select first slice beam particles, cosmics for all subsequent slices.

Definition at line 93 of file BeamParticleIdTool.h.

float lar_content::BeamParticleIdTool::m_tpcMaxX

private

Global TPC volume maximum x extent.

Definition at line 95 of file BeamParticleIdTool.h.

float lar_content::BeamParticleIdTool::m_tpcMaxY

private

Global TPC volume maximum y extent.

Definition at line 97 of file BeamParticleIdTool.h.

float lar_content::BeamParticleIdTool::m_tpcMaxZ

private

Global TPC volume maximum z extent.

Definition at line 99 of file BeamParticleIdTool.h.

float lar_content::BeamParticleIdTool::m_tpcMinX

private

Global TPC volume minimum x extent.

Definition at line 94 of file BeamParticleIdTool.h.

float lar_content::BeamParticleIdTool::m_tpcMinY

private

Global TPC volume minimum y extent.

Definition at line 96 of file BeamParticleIdTool.h.

float lar_content::BeamParticleIdTool::m_tpcMinZ

private

Global TPC volume minimum z extent.

Definition at line 98 of file BeamParticleIdTool.h.

PlaneVector lar_content::BeamParticleIdTool::m_tpcPlanes

private

Vector of all planes making up global TPC volume.

Definition at line 102 of file BeamParticleIdTool.h.

---

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

• BeamParticleIdTool.h
• BeamParticleIdTool.cc