lar_content::LArGeometryHelper Class Reference

LArGeometryHelper class. More...

#include "LArGeometryHelper.h"

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

Static Public Member Functions
static float	MergeTwoPositions (const pandora::Pandora &pandora, const pandora::HitType view1, const pandora::HitType view2, const float position1, const float position2)
	Merge two views (U,V) to give a third view (Z). More...
static pandora::CartesianVector	MergeTwoDirections (const pandora::Pandora &pandora, const pandora::HitType view1, const pandora::HitType view2, const pandora::CartesianVector &direction1, const pandora::CartesianVector &direction2)
	Merge two views (U,V) to give a third view (Z). More...
static void	MergeTwoPositions (const pandora::Pandora &pandora, const pandora::HitType view1, const pandora::HitType view2, const pandora::CartesianVector &position1, const pandora::CartesianVector &position2, pandora::CartesianVector &position3, float &chiSquared)
	Merge 2D positions from two views to give 2D position in third view. More...
static void	MergeTwoPositions (const pandora::Pandora &pandora, const pandora::HitType view1, const pandora::HitType view2, const pandora::CartesianVector &position1, const pandora::CartesianVector &position2, pandora::CartesianVector &outputU, pandora::CartesianVector &outputV, pandora::CartesianVector &outputW, float &chiSquared)
	Merge 2D positions from two views to give 2D position in third view. More...
static void	MergeThreePositions (const pandora::Pandora &pandora, const pandora::HitType view1, const pandora::HitType view2, const pandora::HitType view3, const pandora::CartesianVector &position1, const pandora::CartesianVector &position2, const pandora::CartesianVector &position3, pandora::CartesianVector &outputU, pandora::CartesianVector &outputV, pandora::CartesianVector &outputW, float &chiSquared)
	Merge 2D positions from three views to give unified 2D positions for each view. More...
static void	MergeThreePositions (const pandora::Pandora &pandora, const pandora::CartesianVector &positionU, const pandora::CartesianVector &positionV, const pandora::CartesianVector &positionW, pandora::CartesianVector &outputU, pandora::CartesianVector &outputV, pandora::CartesianVector &outputW, float &chiSquared)
	Merge 2D positions from three views to give unified 2D positions for each view. More...
static void	MergeTwoPositions3D (const pandora::Pandora &pandora, const pandora::HitType view1, const pandora::HitType view2, const pandora::CartesianVector &position1, const pandora::CartesianVector &position2, pandora::CartesianVector &position3D, float &chiSquared)
	Merge 2D positions from two views to give unified 3D position. More...
static void	MergeThreePositions3D (const pandora::Pandora &pandora, const pandora::HitType view1, const pandora::HitType view2, const pandora::HitType view3, const pandora::CartesianVector &position1, const pandora::CartesianVector &position2, const pandora::CartesianVector &position3, pandora::CartesianVector &position3D, float &chiSquared)
	Merge 2D positions from three views to give unified 3D position. More...
static pandora::CartesianVector	ProjectPosition (const pandora::Pandora &pandora, const pandora::CartesianVector &position3D, const pandora::HitType view)
	Project 3D position into a given 2D view. More...
static pandora::CartesianVector	ProjectDirection (const pandora::Pandora &pandora, const pandora::CartesianVector &direction3D, const pandora::HitType view)
	Project 3D direction into a given 2D view. More...
static float	GetWireZPitch (const pandora::Pandora &pandora, const float maxWirePitchDiscrepancy=0.01)
	Return the wire pitch. More...
static float	GetWirePitch (const pandora::Pandora &pandora, const pandora::HitType view, const float maxWirePitchDiscrepancy=0.01)
	Return the wire pitch. More...
static float	GetWirePitchRatio (const pandora::Pandora &pandora, const pandora::HitType view)
	Return the ratio of the wire pitch of the specified view to the minimum wire pitch for the detector. More...
static pandora::CartesianVector	GetWireAxis (const pandora::Pandora &pandora, const pandora::HitType view)
	Return the wire axis (vector perpendicular to the wire direction and drift direction) More...
static bool	IsInGap (const pandora::Pandora &pandora, const pandora::CartesianVector &testPoint2D, const pandora::HitType hitType, const float gapTolerance=0.f)
	Whether a 2D test point lies in a registered gap with the associated hit type. More...
static bool	IsInGap3D (const pandora::Pandora &pandora, const pandora::CartesianVector &testPoint3D, const pandora::HitType hitType, const float gapTolerance=0.f)
	Whether a 3D test point lies in a registered gap with the associated hit type. More...
static bool	IsXSamplingPointInGap (const pandora::Pandora &pandora, const float xSample, const TwoDSlidingFitResult &slidingFitResult, const float gapTolerance=0.f)
	Whether there is a gap in a cluster (described via its sliding fit result) at a specified x sampling position. More...
static float	CalculateGapDeltaZ (const pandora::Pandora &pandora, const float minZ, const float maxZ, const pandora::HitType hitType)
	Calculate the total distance within a given 2D region that is composed of detector gaps. More...
static float	GetSigmaUVW (const pandora::Pandora &pandora, const float maxSigmaDiscrepancy=0.01)
	Find the sigmaUVW value for the detector geometry. More...
static void	GetCommonDaughterVolumes (const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2, UIntSet &intersect)
	Return the set of common daughter volumes between two 2D clusters. More...

Detailed Description

LArGeometryHelper class.

Definition at line 33 of file LArGeometryHelper.h.

Member Typedef Documentation

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

Definition at line 36 of file LArGeometryHelper.h.

Member Function Documentation

float lar_content::LArGeometryHelper::CalculateGapDeltaZ ( const pandora::Pandora &  pandora, const float  minZ, const float  maxZ, const pandora::HitType  hitType  )

static

Calculate the total distance within a given 2D region that is composed of detector gaps.

Parameters

pandora	the associated pandora instance
minZ	the start position in Z
maxZ	the end position in Z
hitType	the hit type

Definition at line 530 of file LArGeometryHelper.cc.

References f.

Referenced by lar_content::TwoDLinearFitFeatureTool::CalculateVariablesSlidingLinearFit(), lar_content::ThreeDLinearFitFeatureTool::CalculateVariablesSlidingLinearFit(), and lar_content::CrossGapsExtensionAlgorithm::IsAcrossGap().

{
    if (maxZ - minZ < std::numeric_limits<float>::epsilon())
        throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);

    float gapDeltaZ(0.f);

    for (const DetectorGap *const pDetectorGap : pandora.GetGeometry()->GetDetectorGapList())
    {
        const LineGap *const pLineGap = dynamic_cast<const LineGap *>(pDetectorGap);

        if (!pLineGap)
            throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);

        const LineGapType lineGapType(pLineGap->GetLineGapType());

        if (!(((TPC_VIEW_U == hitType) && (TPC_WIRE_GAP_VIEW_U == lineGapType)) || ((TPC_VIEW_V == hitType) && (TPC_WIRE_GAP_VIEW_V == lineGapType)) ||
                ((TPC_VIEW_W == hitType) && (TPC_WIRE_GAP_VIEW_W == lineGapType))))
        {
            continue;
        }

        if ((pLineGap->GetLineStartZ() > maxZ) || (pLineGap->GetLineEndZ() < minZ))
            continue;

        const float gapMinZ(std::max(minZ, pLineGap->GetLineStartZ()));
        const float gapMaxZ(std::min(maxZ, pLineGap->GetLineEndZ()));

        if ((gapMaxZ - gapMinZ) > std::numeric_limits<float>::epsilon())
            gapDeltaZ += (gapMaxZ - gapMinZ);
    }

    return gapDeltaZ;
}

void lar_content::LArGeometryHelper::GetCommonDaughterVolumes ( const pandora::Cluster *const  pCluster1, const pandora::Cluster *const  pCluster2, UIntSet &  intersect  )

static

Return the set of common daughter volumes between two 2D clusters.

Parameters

intersect	the set of shared daughter volumes
pCluster1	the first cluster
pCluster2	the second cluster

Definition at line 457 of file LArGeometryHelper.cc.

Referenced by lar_content::CosmicRayTrackRecoveryAlgorithm::MatchClusters(), and lar_content::TwoViewTransverseTracksAlgorithm::TwoViewTransverseTracksAlgorithm().

{
    UIntSet daughterVolumeIds1, daughterVolumeIds2;

    LArClusterHelper::GetDaughterVolumeIDs(pCluster1, daughterVolumeIds1);
    LArClusterHelper::GetDaughterVolumeIDs(pCluster2, daughterVolumeIds2);

    std::set_intersection(daughterVolumeIds1.begin(), daughterVolumeIds1.end(), daughterVolumeIds2.begin(), daughterVolumeIds2.end(),
        std::inserter(intersect, intersect.begin()));
}

float lar_content::LArGeometryHelper::GetSigmaUVW ( const pandora::Pandora &  pandora, const float  maxSigmaDiscrepancy = 0.01  )

static

Find the sigmaUVW value for the detector geometry.

Parameters

pandora	the associated pandora instance
maxSigmaDiscrepancy	maximum allowed discrepancy between lar tpc sigmaUVW values

Definition at line 567 of file LArGeometryHelper.cc.

Referenced by lar_content::ThreeDHitCreationAlgorithm::GetChi2WrtFit(), lar_content::ThreeDHitCreationAlgorithm::GetHitMovementChi2(), lar_content::ThreeDHitCreationAlgorithm::RefineHitPositions(), and lar_content::HitCreationBaseTool::~HitCreationBaseTool().

{
    const LArTPCMap &larTPCMap(pandora.GetGeometry()->GetLArTPCMap());

    if (larTPCMap.empty())
    {
        std::cout << "LArGeometryHelper::GetSigmaUVW - LArTPC description not registered with Pandora as required " << std::endl;
        throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);
    }

    const LArTPC *const pFirstLArTPC(larTPCMap.begin()->second);
    const float sigmaUVW(pFirstLArTPC->GetSigmaUVW());

    for (const LArTPCMap::value_type &mapEntry : larTPCMap)
    {
        const LArTPC *const pLArTPC(mapEntry.second);

        if (std::fabs(sigmaUVW - pLArTPC->GetSigmaUVW()) > maxSigmaDiscrepancy)
        {
            std::cout << "LArGeometryHelper::GetSigmaUVW - Plugin does not support provided LArTPC configurations " << std::endl;
            throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
        }
    }

    return sigmaUVW;
}

CartesianVector lar_content::LArGeometryHelper::GetWireAxis ( const pandora::Pandora &  pandora, const pandora::HitType  view  )

static

Return the wire axis (vector perpendicular to the wire direction and drift direction)

Parameters

pandora	the associated pandora instance
view	the 2D projection

Definition at line 432 of file LArGeometryHelper.cc.

References f.

{
    if (view == TPC_VIEW_U)
    {
        return CartesianVector(0.f, pandora.GetPlugins()->GetLArTransformationPlugin()->YZtoU(1.f, 0.f),
            pandora.GetPlugins()->GetLArTransformationPlugin()->YZtoU(0.f, 1.f));
    }

    else if (view == TPC_VIEW_V)
    {
        return CartesianVector(0.f, pandora.GetPlugins()->GetLArTransformationPlugin()->YZtoV(1.f, 0.f),
            pandora.GetPlugins()->GetLArTransformationPlugin()->YZtoV(0.f, 1.f));
    }

    else if (view == TPC_VIEW_W)
    {
        return CartesianVector(0.f, pandora.GetPlugins()->GetLArTransformationPlugin()->YZtoW(1.f, 0.f),
            pandora.GetPlugins()->GetLArTransformationPlugin()->YZtoW(0.f, 1.f));
    }

    throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
}

float lar_content::LArGeometryHelper::GetWirePitch ( const pandora::Pandora &  pandora, const pandora::HitType  view, const float  maxWirePitchDiscrepancy = 0.01  )

static

Return the wire pitch.

Parameters

pandora	the associated pandora instance
view	the 2D projection
maxWirePitchDiscrepancy	maximum allowed discrepancy between lar tpc wire pitch values

Definition at line 376 of file LArGeometryHelper.cc.

Referenced by lar_content::NViewTrackMatchingAlgorithm< T >::AddToSlidingFitCache(), lar_content::ThreeViewShowersAlgorithm::AddToSlidingFitCache(), lar_content::DeltaRayMatchingAlgorithm::AreClustersMatched(), lar_content::ProtoShowerMatchingTool::AreDirectionsConsistent(), lar_content::CosmicRayVertexBuildingAlgorithm::BuildPointingClusterMap(), lar_content::NeutrinoDaughterVerticesAlgorithm::BuildPointingClusterMap(), lar_content::ShowerStartFinderTool::BuildShowerRegion(), lar_content::TrackHitsBaseTool::BuildSlidingFitMap(), lar_content::CosmicRaySplittingAlgorithm::BuildSlidingFitResultMap(), lar_content::TwoDSlidingFitMultiSplitAlgorithm::BuildSlidingFitResultMap(), lar_content::CosmicRayTrackRecoveryAlgorithm::BuildSlidingFitResultMap(), lar_content::VertexBasedPfoRecoveryAlgorithm::BuildSlidingFitResultMap(), lar_content::TwoDSlidingFitSplittingAndSwitchingAlgorithm::BuildSlidingFitResultMap(), lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::BuildSlidingFitResultMap(), lar_content::TwoDSlidingFitConsolidationAlgorithm::BuildSlidingLinearFits(), lar_content::ParticleRecoveryAlgorithm::CalculateEffectiveSpan(), lar_content::ShowerStartFinderTool::CharacteriseShowerTopology(), lar_content::ConeClusterMopUpAlgorithm::ClusterMopUp(), lar_content::BoundedClusterMopUpAlgorithm::ClusterMopUp(), lar_content::CutPfoCharacterisationAlgorithm::CutPfoCharacterisationAlgorithm(), lar_content::ShowerSpineFinderTool::FindShowerSpine(), lar_content::ConnectionRegionFeatureTool::Get2DKink(), lar_content::SlidingConePfoMopUpAlgorithm::GetClusterMergeMap(), lar_content::SlidingConeClusterMopUpAlgorithm::GetClusterMergeMap(), lar_content::EventSlicingTool::GetClusterSliceList(), lar_content::NeutrinoHierarchyAlgorithm::GetInitialPfoInfoMap(), lar_content::NViewDeltaRayMatchingAlgorithm< T >::GetNearbyMuonPfos(), lar_content::ThreeViewTrackFragmentsAlgorithm::GetProjectedPositions(), lar_content::NViewDeltaRayMatchingAlgorithm< T >::GetProjectedPositions(), lar_content::ElectronInitialRegionRefinementAlgorithm::GetShowerVertex(), lar_content::MissingTrackSegmentTool::GetSlidingFitResultMap(), lar_content::ShowerRegionFeatureTool::GetViewShowerRegionVariables(), lar_content::TrackRefinementBaseAlgorithm::InitialiseContainers(), lar_content::DeltaRayRemovalTool::IsContaminated(), lar_content::CosmicRayRemovalTool::IsContaminated(), lar_content::TwoViewCosmicRayRemovalTool::IsContaminated(), lar_content::ThreeDHitCreationAlgorithm::IterativeTreatment(), lar_content::CrossGapsAssociationAlgorithm::PopulateClusterAssociationMap(), lar_content::ShowerStartFinderTool::Run(), and lar_content::TwoDSlidingFitSplittingAlgorithm::TwoDSlidingFitSplittingAlgorithm().

{
    if (view != TPC_VIEW_U && view != TPC_VIEW_V && view != TPC_VIEW_W && view != TPC_3D)
        throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);

    if (view == TPC_3D)
    {
        const float pitchU{LArGeometryHelper::GetWirePitch(pandora, TPC_VIEW_U, maxWirePitchDiscrepancy)};
        const float pitchV{LArGeometryHelper::GetWirePitch(pandora, TPC_VIEW_V, maxWirePitchDiscrepancy)};
        const float pitchW{LArGeometryHelper::GetWirePitch(pandora, TPC_VIEW_W, maxWirePitchDiscrepancy)};
        return std::max({pitchU, pitchV, pitchW});
    }

    const LArTPCMap &larTPCMap(pandora.GetGeometry()->GetLArTPCMap());

    if (larTPCMap.empty())
    {
        std::cout << "LArGeometryHelper::GetWirePitch - LArTPC description not registered with Pandora as required " << std::endl;
        throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);
    }

    const LArTPC *const pFirstLArTPC(larTPCMap.begin()->second);
    const float wirePitch(view == TPC_VIEW_U ? pFirstLArTPC->GetWirePitchU()
                                             : (view == TPC_VIEW_V ? pFirstLArTPC->GetWirePitchV() : pFirstLArTPC->GetWirePitchW()));

    for (const LArTPCMap::value_type &mapEntry : larTPCMap)
    {
        const LArTPC *const pLArTPC(mapEntry.second);
        const float alternateWirePitch(
            view == TPC_VIEW_U ? pLArTPC->GetWirePitchU() : (view == TPC_VIEW_V ? pLArTPC->GetWirePitchV() : pLArTPC->GetWirePitchW()));

        if (std::fabs(wirePitch - alternateWirePitch) > maxWirePitchDiscrepancy)
        {
            std::cout << "LArGeometryHelper::GetWirePitch - LArTPC configuration not supported" << std::endl;
            throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
        }
    }

    return wirePitch;
}

float lar_content::LArGeometryHelper::GetWirePitchRatio ( const pandora::Pandora &  pandora, const pandora::HitType  view  )

static

Return the ratio of the wire pitch of the specified view to the minimum wire pitch for the detector.

Parameters

pandora	the associated pandora instance
view	the 2D projection

Returns

The ratio of the specified view's wire pitch to the minimum wire pitch

Definition at line 419 of file LArGeometryHelper.cc.

Referenced by lar_content::TrackClusterCreationAlgorithm::AddFilteredCaloHits(), lar_content::TrackClusterCreationAlgorithm::CreatePrimaryAssociation(), lar_content::TrackClusterCreationAlgorithm::CreateSecondaryAssociation(), lar_content::TransverseAssociationAlgorithm::FillTransverseClusterList(), lar_content::TrackClusterCreationAlgorithm::FilterCaloHits(), lar_content::IsolatedClusterMopUpAlgorithm::GetCaloHitToClusterMap(), lar_content::TransverseExtensionAlgorithm::GetListOfCleanClusters(), lar_content::CrossGapsAssociationAlgorithm::IsAssociated(), lar_content::CrossGapsExtensionAlgorithm::IsAssociated(), lar_content::LongitudinalAssociationAlgorithm::IsExtremalCluster(), lar_content::CrossGapsAssociationAlgorithm::IsNearCluster(), lar_content::TransverseAssociationAlgorithm::IsTransverseAssociated(), and lar_content::TrackConsolidationAlgorithm::TrackConsolidationAlgorithm().

{
    const float pitchU{LArGeometryHelper::GetWirePitch(pandora, TPC_VIEW_U)};
    const float pitchV{LArGeometryHelper::GetWirePitch(pandora, TPC_VIEW_V)};
    const float pitchW{LArGeometryHelper::GetWirePitch(pandora, TPC_VIEW_W)};
    const float pitchMin{std::min({pitchU, pitchV, pitchW})};
    const float pitchView{LArGeometryHelper::GetWirePitch(pandora, view)};

    return pitchView / pitchMin;
}

float lar_content::LArGeometryHelper::GetWireZPitch ( const pandora::Pandora &  pandora, const float  maxWirePitchDiscrepancy = 0.01  )

inlinestatic

Return the wire pitch.

Parameters

pandora	the associated pandora instance
maxWirePitchDiscrepancy	maximum allowed discrepancy between lar tpc wire pitch value in the w view

Definition at line 283 of file LArGeometryHelper.h.

Referenced by lar_content::CandidateVertexCreationAlgorithm::AddToSlidingFitCache(), lar_content::VertexSelectionBaseAlgorithm::CalculateClusterSlidingFits(), lar_content::TrainedVertexSelectionAlgorithm::CalculateShowerClusterList(), lar_content::TwoDLinearFitFeatureTool::CalculateVariablesSlidingLinearFit(), lar_content::ThreeDLinearFitFeatureTool::CalculateVariablesSlidingLinearFit(), lar_content::CutClusterCharacterisationAlgorithm::GetShowerFitWidth(), lar_content::CutClusterCharacterisationAlgorithm::IsClearTrack(), lar_content::LArParticleIdPlugins::LArMuonId::LArMuonId(), lar_content::TwoDShowerFitFeatureTool::Run(), and lar_content::TwoDVertexDistanceFeatureTool::Run().

{
    return LArGeometryHelper::GetWirePitch(pandora, pandora::TPC_VIEW_W, maxWirePitchWDiscrepancy);
}

bool lar_content::LArGeometryHelper::IsInGap ( const pandora::Pandora &  pandora, const pandora::CartesianVector &  testPoint2D, const pandora::HitType  hitType, const float  gapTolerance = 0.f  )

static

Whether a 2D test point lies in a registered gap with the associated hit type.

Parameters

pandora	the associated pandora instance
testPoint	the test point
hitType	the hit type
gapTolerance	the gap tolerance

Returns

boolean

Definition at line 470 of file LArGeometryHelper.cc.

Referenced by lar_content::CrossGapsExtensionAlgorithm::BuildPointingClusterList(), lar_content::TracksCrossingGapsTool::CheckXPositionInGap(), lar_content::StitchingCosmicRayMergingTool::CreatePfoMatches(), and lar_content::CrossGapsAssociationAlgorithm::IsAssociated().

{
    // ATTN: input test point MUST be a 2D position vector
    for (const DetectorGap *const pDetectorGap : pandora.GetGeometry()->GetDetectorGapList())
    {
        if (pDetectorGap->IsInGap(testPoint2D, hitType, gapTolerance))
            return true;
    }

    return false;
}

bool lar_content::LArGeometryHelper::IsInGap3D ( const pandora::Pandora &  pandora, const pandora::CartesianVector &  testPoint3D, const pandora::HitType  hitType, const float  gapTolerance = 0.f  )

static

Whether a 3D test point lies in a registered gap with the associated hit type.

Parameters

pandora	the associated pandora instance
testPoint	the test point
hitType	the hit type
gapTolerance	the gap tolerance

Returns

boolean

Definition at line 484 of file LArGeometryHelper.cc.

Referenced by lar_content::VertexSelectionBaseAlgorithm::IsVertexInGap().

{
    const CartesianVector testPoint2D(LArGeometryHelper::ProjectPosition(pandora, testPoint3D, hitType));
    return LArGeometryHelper::IsInGap(pandora, testPoint2D, hitType, gapTolerance);
}

bool lar_content::LArGeometryHelper::IsXSamplingPointInGap ( const pandora::Pandora &  pandora, const float  xSample, const TwoDSlidingFitResult &  slidingFitResult, const float  gapTolerance = 0.f  )

static

Whether there is a gap in a cluster (described via its sliding fit result) at a specified x sampling position.

Parameters

pandora	the associated pandora instance
xSample	the x sampling position
slidingFitResult	the sliding fit result for a cluster
gapTolerance	the gap tolerance

Returns

boolean

Definition at line 492 of file LArGeometryHelper.cc.

References f, lar_content::TwoDSlidingFitResult::GetCluster(), lar_content::TwoDSlidingFitResult::GetGlobalFitPositionAtX(), lar_content::TwoDSlidingFitResult::GetGlobalMaxLayerDirection(), lar_content::TwoDSlidingFitResult::GetGlobalMaxLayerPosition(), lar_content::TwoDSlidingFitResult::GetGlobalMinLayerDirection(), and lar_content::TwoDSlidingFitResult::GetGlobalMinLayerPosition().

Referenced by lar_content::ParticleRecoveryAlgorithm::CalculateEffectiveSpan(), and lar_content::TracksCrossingGapsTool::CheckXPositionInGap().

{
    const HitType hitType(LArClusterHelper::GetClusterHitType(slidingFitResult.GetCluster()));
    const CartesianVector minLayerPosition(slidingFitResult.GetGlobalMinLayerPosition());
    const CartesianVector maxLayerPosition(slidingFitResult.GetGlobalMaxLayerPosition());

    const bool minLayerIsAtLowX(minLayerPosition.GetX() < maxLayerPosition.GetX());
    const CartesianVector &lowXCoordinate(minLayerIsAtLowX ? minLayerPosition : maxLayerPosition);
    const CartesianVector &highXCoordinate(minLayerIsAtLowX ? maxLayerPosition : minLayerPosition);

    if ((xSample > lowXCoordinate.GetX()) && (xSample < highXCoordinate.GetX()))
    {
        CartesianVector slidingFitPosition(0.f, 0.f, 0.f);

        if (STATUS_CODE_SUCCESS == slidingFitResult.GetGlobalFitPositionAtX(xSample, slidingFitPosition))
            return (LArGeometryHelper::IsInGap(pandora, slidingFitPosition, hitType, gapTolerance));
    }

    const CartesianVector lowXDirection(
        minLayerIsAtLowX ? slidingFitResult.GetGlobalMinLayerDirection() : slidingFitResult.GetGlobalMaxLayerDirection());
    const CartesianVector highXDirection(
        minLayerIsAtLowX ? slidingFitResult.GetGlobalMaxLayerDirection() : slidingFitResult.GetGlobalMinLayerDirection());

    const bool sampleIsNearerToLowX(std::fabs(xSample - lowXCoordinate.GetX()) < std::fabs(xSample - highXCoordinate.GetX()));
    const CartesianVector &startPosition(sampleIsNearerToLowX ? lowXCoordinate : highXCoordinate);
    const CartesianVector &startDirection(sampleIsNearerToLowX ? lowXDirection : highXDirection);

    if (std::fabs(startDirection.GetX()) < std::numeric_limits<float>::epsilon())
        throw StatusCodeException(STATUS_CODE_NOT_FOUND);

    const float pathLength((xSample - startPosition.GetX()) / startDirection.GetX());
    const CartesianVector samplingPoint(startPosition + startDirection * pathLength);

    return (LArGeometryHelper::IsInGap(pandora, samplingPoint, hitType, gapTolerance));
}

static void lar_content::LArGeometryHelper::MergeThreePositions ( const pandora::Pandora &  pandora, const pandora::HitType  view1, const pandora::HitType  view2, const pandora::HitType  view3, const pandora::CartesianVector &  position1, const pandora::CartesianVector &  position2, const pandora::CartesianVector &  position3, pandora::CartesianVector &  outputU, pandora::CartesianVector &  outputV, pandora::CartesianVector &  outputW, float &  chiSquared  )

static

Merge 2D positions from three views to give unified 2D positions for each view.

Parameters

pandora	the associated pandora instance
view1	the first view
view2	the second view
view3	the third view
position1	the position in the first view
position2	the position in the second view
position3	the position in the third view
positionU	output position in the U view
positionV	output position in the V view
positionW	output position in the W view
chi-squared

Referenced by lar_content::ThreeViewLongitudinalTracksAlgorithm::ThreeViewLongitudinalTracksAlgorithm().

static void lar_content::LArGeometryHelper::MergeThreePositions ( const pandora::Pandora &  pandora, const pandora::CartesianVector &  positionU, const pandora::CartesianVector &  positionV, const pandora::CartesianVector &  positionW, pandora::CartesianVector &  outputU, pandora::CartesianVector &  outputV, pandora::CartesianVector &  outputW, float &  chiSquared  )

static

Merge 2D positions from three views to give unified 2D positions for each view.

Parameters

pandora	the associated pandora instance
positionU	input position in the U view
positionV	input position in the V view
positionW	input position in the W view
positionU	output position in the U view
positionV	output position in the V view
positionW	output position in the W view
chi-squared

void lar_content::LArGeometryHelper::MergeThreePositions3D ( const pandora::Pandora &  pandora, const pandora::HitType  view1, const pandora::HitType  view2, const pandora::HitType  view3, const pandora::CartesianVector &  position1, const pandora::CartesianVector &  position2, const pandora::CartesianVector &  position3, pandora::CartesianVector &  position3D, float &  chiSquared  )

static

Merge 2D positions from three views to give unified 3D position.

Parameters

pandora	the associated pandora instance
view1	the first view
view2	the second view
view3	the third view
position1	the position in the first view
position2	the position in the second view
position3	the position in the third view
position3D	output position in 3D
chi-squared

Definition at line 311 of file LArGeometryHelper.cc.

References f.

Referenced by lar_content::UndershootTracksTool::IsThreeDKink(), lar_content::OvershootTracksTool::IsThreeDKink(), lar_content::VertexBasedPfoRecoveryAlgorithm::MatchTwoViews(), and lar_content::VertexRefinementAlgorithm::RefineVertices().

{
    CartesianVector positionU(0.f, 0.f, 0.f), positionV(0.f, 0.f, 0.f), positionW(0.f, 0.f, 0.f);
    LArGeometryHelper::MergeThreePositions(pandora, view1, view2, view3, position1, position2, position3, positionU, positionV, positionW, chiSquared);

    position3D.SetValues(positionW.GetX(), pandora.GetPlugins()->GetLArTransformationPlugin()->UVtoY(positionU.GetZ(), positionV.GetZ()),
        pandora.GetPlugins()->GetLArTransformationPlugin()->UVtoZ(positionU.GetZ(), positionV.GetZ()));
}

CartesianVector lar_content::LArGeometryHelper::MergeTwoDirections ( const pandora::Pandora &  pandora, const pandora::HitType  view1, const pandora::HitType  view2, const pandora::CartesianVector &  direction1, const pandora::CartesianVector &  direction2  )

static

Merge two views (U,V) to give a third view (Z).

Parameters

pandora	the associated pandora instance
view1	the first view
view2	the second view
direction1	the direction in the first view
direction2	the direction in the second view

Definition at line 71 of file LArGeometryHelper.cc.

References f, Z1, and Z2.

Referenced by lar_content::ProtoShowerMatchingTool::AreDirectionsConsistent().

{
    // x components must be consistent
    if (direction1.GetX() * direction2.GetX() < 0.f)
        throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);

    // scale x components to a common value
    const float s1((std::fabs(direction1.GetX()) > std::numeric_limits<float>::epsilon()) ? 100.f * std::fabs(direction2.GetX()) : 1.f);
    const float s2((std::fabs(direction2.GetX()) > std::numeric_limits<float>::epsilon()) ? 100.f * std::fabs(direction1.GetX()) : 1.f);

    float pX(s1 * direction1.GetX()), pU(0.f), pV(0.f), pW(0.f);
    HitType newView(HIT_CUSTOM);

    if ((view1 == TPC_VIEW_U) && (view2 == TPC_VIEW_V))
    {
        pU = s1 * direction1.GetZ();
        pV = s2 * direction2.GetZ();
        newView = TPC_VIEW_W;
    }

    if ((view1 == TPC_VIEW_V) && (view2 == TPC_VIEW_U))
    {
        pV = s1 * direction1.GetZ();
        pU = s2 * direction2.GetZ();
        newView = TPC_VIEW_W;
    }

    if ((view1 == TPC_VIEW_W) && (view2 == TPC_VIEW_U))
    {
        pW = s1 * direction1.GetZ();
        pU = s2 * direction2.GetZ();
        newView = TPC_VIEW_V;
    }

    if ((view1 == TPC_VIEW_U) && (view2 == TPC_VIEW_W))
    {
        pU = s1 * direction1.GetZ();
        pW = s2 * direction2.GetZ();
        newView = TPC_VIEW_V;
    }

    if ((view1 == TPC_VIEW_V) && (view2 == TPC_VIEW_W))
    {
        pV = s1 * direction1.GetZ();
        pW = s2 * direction2.GetZ();
        newView = TPC_VIEW_U;
    }

    if ((view1 == TPC_VIEW_W) && (view2 == TPC_VIEW_V))
    {
        pW = s1 * direction1.GetZ();
        pV = s2 * direction2.GetZ();
        newView = TPC_VIEW_U;
    }

    if (newView == TPC_VIEW_W)
        return CartesianVector(pX, 0.f, pandora.GetPlugins()->GetLArTransformationPlugin()->UVtoW(pU, pV)).GetUnitVector();

    if (newView == TPC_VIEW_U)
        return CartesianVector(pX, 0.f, pandora.GetPlugins()->GetLArTransformationPlugin()->VWtoU(pV, pW)).GetUnitVector();

    if (newView == TPC_VIEW_V)
        return CartesianVector(pX, 0.f, pandora.GetPlugins()->GetLArTransformationPlugin()->WUtoV(pW, pU)).GetUnitVector();

    throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
}

static float lar_content::LArGeometryHelper::MergeTwoPositions ( const pandora::Pandora &  pandora, const pandora::HitType  view1, const pandora::HitType  view2, const float  position1, const float  position2  )

static

Merge two views (U,V) to give a third view (Z).

Parameters

pandora	the associated pandora instance
view1	the first view
view2	the second view
position1	the position in the first view
position2	the position in the second view

Referenced by lar_content::DeltaRayMatchingAlgorithm::AreClustersMatched(), lar_content::ProtoShowerMatchingTool::AreShowerStartsConsistent(), lar_content::ThreeViewRemnantsAlgorithm::CalculateOverlapResult(), lar_content::ParticleRecoveryAlgorithm::CheckConsistency(), lar_content::CosmicRayShowerMatchingAlgorithm::CheckMatchedClusters3D(), lar_content::CosmicRayTrackMatchingAlgorithm::CheckMatchedClusters3D(), lar_content::TracksCrossingGapsTool::CheckXPositionInGap(), lar_content::NViewDeltaRayMatchingAlgorithm< T >::GetNearbyMuonPfos(), lar_content::ThreeViewTrackFragmentsAlgorithm::GetProjectedPositions(), lar_content::NViewDeltaRayMatchingAlgorithm< T >::GetProjectedPositions(), lar_content::ThreeViewTransverseTracksAlgorithm::GetSegmentOverlap(), lar_content::MissingTrackSegmentTool::GetSegmentOverlapMap(), lar_content::ThreeViewShowerHitsTool::GetShowerHit3D(), lar_content::ThreeViewShowersAlgorithm::GetShowerPositionMaps(), lar_content::TrackSplittingTool::PassesChecks(), and lar_content::OvershootTracksTool::SetSplitPosition().

static void lar_content::LArGeometryHelper::MergeTwoPositions ( const pandora::Pandora &  pandora, const pandora::HitType  view1, const pandora::HitType  view2, const pandora::CartesianVector &  position1, const pandora::CartesianVector &  position2, pandora::CartesianVector &  position3, float &  chiSquared  )

static

Merge 2D positions from two views to give 2D position in third view.

Parameters

pandora	the associated pandora instance
view1	the first view
view2	the second view
position1	the position in the first view
position2	the position in the second view
position3	output position in the third view
chi-squared

static void lar_content::LArGeometryHelper::MergeTwoPositions ( const pandora::Pandora &  pandora, const pandora::HitType  view1, const pandora::HitType  view2, const pandora::CartesianVector &  position1, const pandora::CartesianVector &  position2, pandora::CartesianVector &  outputU, pandora::CartesianVector &  outputV, pandora::CartesianVector &  outputW, float &  chiSquared  )

static

Merge 2D positions from two views to give 2D position in third view.

Parameters

view1	the first view
view2	the second view
position1	the position in the first view
position2	the position in the second view
positionU	output position in the U view
positionV	output position in the V view
positionW	output position in the W view
chi-squared

void lar_content::LArGeometryHelper::MergeTwoPositions3D ( const pandora::Pandora &  pandora, const pandora::HitType  view1, const pandora::HitType  view2, const pandora::CartesianVector &  position1, const pandora::CartesianVector &  position2, pandora::CartesianVector &  position3D, float &  chiSquared  )

static

Merge 2D positions from two views to give unified 3D position.

Parameters

pandora	the associated pandora instance
view1	the first view
view2	the second view
position1	the position in the first view
position2	the position in the second view
position3D	output position in 3D
chi-squared

Definition at line 299 of file LArGeometryHelper.cc.

References f.

Referenced by lar_content::CandidateVertexCreationAlgorithm::CreateCrossingVertices(), lar_content::CandidateVertexCreationAlgorithm::CreateEndpointVertex(), lar_content::ThreeViewTrackFragmentsAlgorithm::GetProjectedPositions(), lar_content::TwoViewThreeDKinkTool::IsThreeDKink(), lar_content::VertexBasedPfoRecoveryAlgorithm::MatchTwoViews(), lar_content::VertexRefinementAlgorithm::RefineVertices(), lar_content::ThreeViewLongitudinalTracksAlgorithm::ThreeViewLongitudinalTracksAlgorithm(), lar_content::LongitudinalTrackHitsBaseTool::UpdateBestPosition(), and lar_content::HitCreationBaseTool::~HitCreationBaseTool().

{
    CartesianVector positionU(0.f, 0.f, 0.f), positionV(0.f, 0.f, 0.f), positionW(0.f, 0.f, 0.f);
    LArGeometryHelper::MergeTwoPositions(pandora, view1, view2, position1, position2, positionU, positionV, positionW, chiSquared);

    position3D.SetValues(positionW.GetX(), pandora.GetPlugins()->GetLArTransformationPlugin()->UVtoY(positionU.GetZ(), positionV.GetZ()),
        pandora.GetPlugins()->GetLArTransformationPlugin()->UVtoZ(positionU.GetZ(), positionV.GetZ()));
}

CartesianVector lar_content::LArGeometryHelper::ProjectDirection ( const pandora::Pandora &  pandora, const pandora::CartesianVector &  direction3D, const pandora::HitType  view  )

static

Project 3D direction into a given 2D view.

Parameters

pandora	the associated pandora instance
direction3D	the direction in 3D
view	the 2D projection

Definition at line 348 of file LArGeometryHelper.cc.

{
    if (view == TPC_VIEW_U)
    {
        return CartesianVector(
            direction3D.GetX(), 0.f, pandora.GetPlugins()->GetLArTransformationPlugin()->YZtoU(direction3D.GetY(), direction3D.GetZ()))
            .GetUnitVector();
    }

    else if (view == TPC_VIEW_V)
    {
        return CartesianVector(
            direction3D.GetX(), 0.f, pandora.GetPlugins()->GetLArTransformationPlugin()->YZtoV(direction3D.GetY(), direction3D.GetZ()))
            .GetUnitVector();
    }

    else if (view == TPC_VIEW_W)
    {
        return CartesianVector(
            direction3D.GetX(), 0.f, pandora.GetPlugins()->GetLArTransformationPlugin()->YZtoW(direction3D.GetY(), direction3D.GetZ()))
            .GetUnitVector();
    }

    throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
}

CartesianVector lar_content::LArGeometryHelper::ProjectPosition ( const pandora::Pandora &  pandora, const pandora::CartesianVector &  position3D, const pandora::HitType  view  )

static

Project 3D position into a given 2D view.

Parameters

pandora	the associated pandora instance
position3D	the position in 3D
view	the 2D projection

Definition at line 323 of file LArGeometryHelper.cc.

Referenced by lar_content::ElectronInitialRegionRefinementAlgorithm::BuildViewPathways(), lar_content::ElectronInitialRegionRefinementAlgorithm::BuildViewProtoShowers(), lar_content::SplitShowersTool::CheckClusterVertexRelations(), lar_content::ConeClusterMopUpAlgorithm::ClusterMopUp(), lar_content::NearbyClusterMopUpAlgorithm::ClusterMopUp(), lar_content::RPhiFeatureTool::FillKernelEstimate(), lar_content::VertexSplittingAlgorithm::FindBestSplitPosition(), lar_content::ShowerGrowingAlgorithm::GetAllVertexSeedCandidates(), lar_content::VertexBasedPfoMopUpAlgorithm::GetClusterAssociation(), lar_content::SlidingConeClusterMopUpAlgorithm::GetClusterMergeMap(), lar_content::ShowerGrowingAlgorithm::GetFigureOfMerit(), lar_content::ThreeDHitCreationAlgorithm::GetHitMovementChi2(), lar_content::VertexBasedPfoMopUpAlgorithm::GetInputPfos(), lar_content::EventSlicingTool::GetKDTreeEntries3D(), lar_content::ConnectionRegionFeatureTool::GetLargest2DKinkFromView(), lar_content::ThreeViewTrackFragmentsAlgorithm::GetProjectedPositions(), lar_content::TrainedVertexSelectionAlgorithm::GetSharedFeatures(), lar_content::ElectronInitialRegionRefinementAlgorithm::GetShowerVertex(), lar_content::LongitudinalTrackHitsBaseTool::GetVertexAndEndPositions(), lar_content::CutClusterCharacterisationAlgorithm::GetVertexDistance(), lar_content::AmbiguousRegionFeatureTool::GetViewAmbiguousHitVariables(), lar_content::InitialRegionFeatureTool::GetViewInitialRegionVariables(), lar_content::ShowerRegionFeatureTool::GetViewShowerRegionVariables(), lar_content::ElectronInitialRegionRefinementAlgorithm::IsSpineCoincident(), lar_content::VertexSelectionBaseAlgorithm::IsVertexOnHit(), lar_content::VertexBasedPfoRecoveryAlgorithm::MatchTwoViews(), lar_content::ThreeDChargeFeatureTool::OrderCaloHitsByDistanceToVertex(), lar_content::ElectronInitialRegionRefinementAlgorithm::RefineHitsToAdd(), lar_content::ElectronInitialRegionRefinementAlgorithm::RefineShowerVertex(), lar_content::VertexRefinementAlgorithm::RefineVertices(), lar_content::ShowerSpineFinderTool::Run(), lar_content::PeakDirectionFinderTool::Run(), lar_content::EnergyKickFeatureTool::Run(), lar_content::AsymmetryFeatureBaseTool::Run(), lar_content::VertexBasedPfoRecoveryAlgorithm::SelectVertexClusters(), lar_content::ThreeViewLongitudinalTracksAlgorithm::ThreeViewLongitudinalTracksAlgorithm(), and lar_content::VertexSelectionBaseAlgorithm::VertexHitEnergy().

{
    if (view == TPC_VIEW_U)
    {
        return CartesianVector(
            position3D.GetX(), 0.f, pandora.GetPlugins()->GetLArTransformationPlugin()->YZtoU(position3D.GetY(), position3D.GetZ()));
    }

    else if (view == TPC_VIEW_V)
    {
        return CartesianVector(
            position3D.GetX(), 0.f, pandora.GetPlugins()->GetLArTransformationPlugin()->YZtoV(position3D.GetY(), position3D.GetZ()));
    }

    else if (view == TPC_VIEW_W)
    {
        return CartesianVector(
            position3D.GetX(), 0.f, pandora.GetPlugins()->GetLArTransformationPlugin()->YZtoW(position3D.GetY(), position3D.GetZ()));
    }

    throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
}

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArHelpers/LArGeometryHelper.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArHelpers/LArGeometryHelper.cc