Detector interface for ProtoDUNE dual phase. More...

#include "ProtoDUNEDualPhase.h"

Inheritance diagram for lar_pandora::ProtoDUNEDualPhase:

Public Member Functions
geo::View_t	TargetViewU (const geo::TPCID::TPCID_t tpc, const geo::CryostatID::CryostatID_t cstat) const override
	Map a LArSoft view to Pandora's U view. More...

geo::View_t	TargetViewV (const geo::TPCID::TPCID_t tpc, const geo::CryostatID::CryostatID_t cstat) const override
	Map a LArSoft view to Pandora's V view. More...

geo::View_t	TargetViewW (const geo::TPCID::TPCID_t tpc, const geo::CryostatID::CryostatID_t cstat) const override
	Map a LArSoft view to Pandora's W view. More...

float	WirePitchW () const override
	The wire pitch of the mapped W view. More...

float	WireAngleW (const geo::TPCID::TPCID_t tpc, const geo::CryostatID::CryostatID_t cstat) const override
	The angle of the wires in the mapped V view. More...

bool	CheckDetectorGapSize (const geo::Vector_t &gaps, const geo::Vector_t &deltas, const float maxDisplacement) const override
	Check whether a gap size is small enough to be registered as a detector gap. More...

LArDetectorGap	CreateDetectorGap (const geo::Point_t &point1, const geo::Point_t &point2, const geo::Vector_t &widths) const override
	Create a detector gap. More...

void	LoadDaughterDetectorGaps (const LArDriftVolume &driftVolume, const float maxDisplacement, LArDetectorGapList &listOfGaps) const override
	Create detector gaps for all daughter volumes in a logical TPC volume. More...

PandoraApi::Geometry::LineGap::Parameters	CreateLineGapParametersFromDetectorGaps (const LArDetectorGap &gap) const override
	Create the line gap parameters to give to the pandora API. More...

PandoraApi::Geometry::LineGap::Parameters	CreateLineGapParametersFromReadoutGaps (const geo::View_t view, const geo::TPCID::TPCID_t tpc, const geo::CryostatID::CryostatID_t cstat, const geo::Point_t &firstXYZ, const geo::Point_t &lastXYZ, const float halfWirePitch, const float xFirst, const float xLast, const pandora::Pandora *pPandora) const override
	Create the line gap parameters to give to the pandora API. More...

float	WirePitchU () const override
	The wire pitch of the mapped U view. More...

float	WirePitchV () const override
	The wire pitch of the mapped V view. More...

float	WireAngleU (const geo::TPCID::TPCID_t tpc, const geo::CryostatID::CryostatID_t cstat) const override
	The angle of the wires in the mapped U view. More...

float	WireAngleV (const geo::TPCID::TPCID_t tpc, const geo::CryostatID::CryostatID_t cstat) const override
	The angle of the wires in the mapped V view. More...

const geo::GeometryCore &	GetLArSoftGeometry () const
	Loan the LArSoft geometry handle owned by this class. More...

const geo::WireReadoutGeom &	GetChannelMap () const

Detailed Description

Detector interface for ProtoDUNE dual phase.

Definition at line 20 of file ProtoDUNEDualPhase.h.

Member Function Documentation

bool lar_pandora::ProtoDUNEDualPhase::CheckDetectorGapSize	(	const geo::Vector_t &	gaps,
		const geo::Vector_t &	deltas,
		const float	maxDisplacement
	)		const

inlineoverridevirtual

Check whether a gap size is small enough to be registered as a detector gap.

Parameters

gaps	a cartesean vector holding gap sizes between adjacent TPCs
deltas	a cartesean vector holding distances between adjacent TPCs
maxDisplacement	the gap size threshold

Returns: logic bool

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 107 of file ProtoDUNEDualPhase.h.

Referenced by LoadDaughterDetectorGaps().

   {
     return (std::fabs(gaps.Y()) > maxDisplacement || std::fabs(gaps.Z()) > maxDisplacement);
   }

LArDetectorGap lar_pandora::ProtoDUNEDualPhase::CreateDetectorGap	(	const geo::Point_t &	point1,
		const geo::Point_t &	point2,
		const geo::Vector_t &	widths
	)		const

inlineoverridevirtual

Create a detector gap.

Parameters

point1	a point on TPC1 that are closest to TPC2
point2	a point on TPC2 that are closest to TPC1
width	the gap sizes

Returns: the detector gap object

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 116 of file ProtoDUNEDualPhase.h.

Referenced by LoadDaughterDetectorGaps().

   {
     return LArDetectorGap(point1.X(),
                           point1.Y() + widths.Y(),
                           point1.Z() + widths.Z(),
                           point2.X(),
                           point2.Y() - widths.Y(),
                           point2.Z() - widths.Z());
   }

PandoraApi::Geometry::LineGap::Parameters lar_pandora::ProtoDUNEDualPhase::CreateLineGapParametersFromDetectorGaps ( const LArDetectorGap & gap ) const

inlineoverridevirtual

Create the line gap parameters to give to the pandora API.

Parameters

gap	the input detector gap

Returns: the pandora API's line gap parameters object

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 131 of file ProtoDUNEDualPhase.h.

References lar_pandora::LArDetectorGap::GetX1(), lar_pandora::LArDetectorGap::GetX2(), lar_pandora::LArDetectorGap::GetY1(), lar_pandora::LArDetectorGap::GetY2(), lar_pandora::LArDetectorGap::GetZ1(), and lar_pandora::LArDetectorGap::GetZ2().

   {
     const bool isGapInU((
       std::fabs(gap.GetY2() - gap.GetY1()) >
       gap
         .GetMaxGapSize())); //Could have chosen Z here, resulting in switching Y<->Z and U<->V in the block below
     PandoraApi::Geometry::LineGap::Parameters parameters;
     parameters.m_lineGapType =
       (isGapInU ?
          pandora::TPC_WIRE_GAP_VIEW_U :
          pandora::
            TPC_WIRE_GAP_VIEW_V); //If gapSizeY is too large then the gap is in Z, therefore should be in kU (i.e. kZ)
     parameters.m_lineStartX = gap.GetX2();
     parameters.m_lineEndX = gap.GetX1();
     parameters.m_lineStartZ = (isGapInU ? gap.GetZ1() : gap.GetY1());
     parameters.m_lineEndZ = (isGapInU ? gap.GetZ2() : gap.GetY2());
 
     return parameters;
   }

PandoraApi::Geometry::LineGap::Parameters lar_pandora::ProtoDUNEDualPhase::CreateLineGapParametersFromReadoutGaps	(	const geo::View_t	view,
		const geo::TPCID::TPCID_t	tpc,
		const geo::CryostatID::CryostatID_t	cstat,
		const geo::Point_t &	firstXYZ,
		const geo::Point_t &	lastXYZ,
		const float	halfWirePitch,
		const float	xFirst,
		const float	xLast,
		const pandora::Pandora *	pPandora
	)		const

inlineoverridevirtual

Create the line gap parameters to give to the pandora API.

Parameters

view	the LArSoft view
tpc	the LArSoft TPC ID
cstat	the LArSoft cryostat ID
firstXYZ	the first 3D coordinate
lastXYZ	the last 3D coordinate
halfWirePitch	the half wire pitch
pPandora	the pandora instance
xFirst	the min X of the gap
xLast	the max X of the gap

Returns: the pandora API's line gap parameters object

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 154 of file ProtoDUNEDualPhase.h.

References lar_pandora::detector_functions::CreateReadoutGapParameters(), f, TargetViewU(), and TargetViewV().

   {
     float first(0.f), last(0.f);
     pandora::LineGapType gapType(pandora::TPC_DRIFT_GAP);
     if (view == this->TargetViewU(tpc, cstat)) {
       first = firstXYZ.Z();
       last = lastXYZ.Z();
       gapType = pandora::TPC_WIRE_GAP_VIEW_U;
     }
     else if (view == this->TargetViewV(tpc, cstat)) {
       first = firstXYZ.Y();
       last = lastXYZ.Y();
       gapType = pandora::TPC_WIRE_GAP_VIEW_V;
     }
     return detector_functions::CreateReadoutGapParameters(
       first, last, xFirst, xLast, halfWirePitch, gapType);
   }

const geo::WireReadoutGeom & lar_pandora::VintageLArTPCThreeView::GetChannelMap ( ) const

inlineinherited

Definition at line 254 of file VintageLArTPCThreeView.h.

References lar_pandora::VintageLArTPCThreeView::m_wireReadoutGeom.

Referenced by lar_pandora::DUNEFarDetVDThreeView::TargetViewU(), lar_pandora::ICARUS::TargetViewU(), TargetViewU(), lar_pandora::DUNEFarDetVDThreeView::TargetViewV(), TargetViewV(), lar_pandora::ICARUS::TargetViewV(), lar_pandora::DUNEFarDetVDThreeView::TargetViewW(), lar_pandora::ICARUS::TargetViewW(), and lar_pandora::ICARUS::WireAngleW().

   {
     return *m_wireReadoutGeom;
   }

const geo::GeometryCore & lar_pandora::VintageLArTPCThreeView::GetLArSoftGeometry ( ) const

inlineinherited

Loan the LArSoft geometry handle owned by this class.

Returns: The LArSoft geometry handle

Definition at line 249 of file VintageLArTPCThreeView.h.

References lar_pandora::VintageLArTPCThreeView::m_LArSoftGeometry.

Referenced by lar_pandora::ICARUS::TargetViewU(), and lar_pandora::ICARUS::TargetViewV().

   {
     return *m_LArSoftGeometry;
   }

void lar_pandora::ProtoDUNEDualPhase::LoadDaughterDetectorGaps	(	const LArDriftVolume &	driftVolume,
		const float	maxDisplacement,
		LArDetectorGapList &	listOfGaps
	)		const

overridevirtual

Create detector gaps for all daughter volumes in a logical TPC volume.

Parameters

driftVolume	the parent drift volume
maxDisplacement	the gap size threshold
listOfGaps	the gaps vector to be filled

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 13 of file ProtoDUNEDualPhase.cxx.

References CheckDetectorGapSize(), CreateDetectorGap(), f, lar_pandora::LArDaughterDriftVolume::GetCenterX(), lar_pandora::LArDaughterDriftVolume::GetCenterY(), lar_pandora::LArDaughterDriftVolume::GetCenterZ(), lar_pandora::LArDaughterDriftVolume::GetTpc(), lar_pandora::LArDriftVolume::GetTpcVolumeList(), lar_pandora::LArDaughterDriftVolume::GetWidthX(), lar_pandora::LArDaughterDriftVolume::GetWidthY(), lar_pandora::LArDaughterDriftVolume::GetWidthZ(), X1, X2, Y1, Y2, Z1, and Z2.

   {
     for (LArDaughterDriftVolumeList::const_iterator
            iterDghtr1 = driftVolume.GetTpcVolumeList().begin(),
            iterDghtrEnd1 = driftVolume.GetTpcVolumeList().end();
          iterDghtr1 != iterDghtrEnd1;
          ++iterDghtr1) {
       const LArDaughterDriftVolume& tpcVolume1(*iterDghtr1);
 
       for (LArDaughterDriftVolumeList::const_iterator
              iterDghtr2 = iterDghtr1,
              iterDghtrEnd2 = driftVolume.GetTpcVolumeList().end();
            iterDghtr2 != iterDghtrEnd2;
            ++iterDghtr2) {
         const LArDaughterDriftVolume& tpcVolume2(*iterDghtr2);
 
         if (tpcVolume1.GetTpc() == tpcVolume2.GetTpc()) continue;
 
         const float deltaX(std::fabs(tpcVolume1.GetCenterX() - tpcVolume2.GetCenterX()));
         const float deltaY(std::fabs(tpcVolume1.GetCenterY() - tpcVolume2.GetCenterY()));
         const float deltaZ(std::fabs(tpcVolume1.GetCenterZ() - tpcVolume2.GetCenterZ()));
 
         const float widthX(0.5f * (tpcVolume1.GetWidthX() + tpcVolume2.GetWidthX()));
         const float widthY(0.5f * (tpcVolume1.GetWidthY() + tpcVolume2.GetWidthY()));
         const float widthZ(0.5f * (tpcVolume1.GetWidthZ() + tpcVolume2.GetWidthZ()));
 
         const float gapX(deltaX - widthX);
         const float gapY(deltaY - widthY);
         const float gapZ(deltaZ - widthZ);
 
         const float X1((tpcVolume1.GetCenterX() < tpcVolume2.GetCenterX()) ?
                          (tpcVolume1.GetCenterX() + 0.5f * tpcVolume1.GetWidthX()) :
                          (tpcVolume2.GetCenterX() + 0.5f * tpcVolume2.GetWidthX()));
         const float X2((tpcVolume1.GetCenterX() > tpcVolume2.GetCenterX()) ?
                          (tpcVolume1.GetCenterX() - 0.5f * tpcVolume1.GetWidthX()) :
                          (tpcVolume2.GetCenterX() - 0.5f * tpcVolume2.GetWidthX()));
         const float Y1(std::min((tpcVolume1.GetCenterY() - 0.5f * tpcVolume1.GetWidthY()),
                                 (tpcVolume2.GetCenterY() - 0.5f * tpcVolume2.GetWidthY())));
         const float Y2(std::max((tpcVolume1.GetCenterY() + 0.5f * tpcVolume1.GetWidthY()),
                                 (tpcVolume2.GetCenterY() + 0.5f * tpcVolume2.GetWidthY())));
         const float Z1(std::min((tpcVolume1.GetCenterZ() - 0.5f * tpcVolume1.GetWidthZ()),
                                 (tpcVolume2.GetCenterZ() - 0.5f * tpcVolume2.GetWidthZ())));
         const float Z2(std::max((tpcVolume1.GetCenterZ() + 0.5f * tpcVolume1.GetWidthZ()),
                                 (tpcVolume2.GetCenterZ() + 0.5f * tpcVolume2.GetWidthZ())));
 
         geo::Vector_t gaps(gapX, gapY, gapZ), deltas(deltaX, deltaY, deltaZ);
         if (this->CheckDetectorGapSize(gaps, deltas, maxDisplacement)) {
           geo::Point_t point1(X1, Y1, Z1), point2(X2, Y2, Z2);
           geo::Vector_t widths(widthX, widthY, widthZ);
           listOfGaps.emplace_back(this->CreateDetectorGap(point1, point2, widths));
         }
       }
     }
 
     return;
   }

geo::View_t lar_pandora::ProtoDUNEDualPhase::TargetViewU	(	const geo::TPCID::TPCID_t	tpc,
		const geo::CryostatID::CryostatID_t	cstat
	)		const

inlineoverridevirtual

Map a LArSoft view to Pandora's U view.

Parameters

tpc	the LArSoft TPC ID
cstat	the LArSoft cryostat ID

Returns: The mapped LArSoft view

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 65 of file ProtoDUNEDualPhase.h.

References lar_pandora::VintageLArTPCThreeView::GetChannelMap(), and geo::WireReadoutGeom::Plane().

Referenced by CreateLineGapParametersFromReadoutGaps().

   {
     return this->GetChannelMap().Plane({cstat, tpc, 1}).View();
   }

geo::View_t lar_pandora::ProtoDUNEDualPhase::TargetViewV	(	const geo::TPCID::TPCID_t	tpc,
		const geo::CryostatID::CryostatID_t	cstat
	)		const

inlineoverridevirtual

Map a LArSoft view to Pandora's V view.

Parameters

tpc	the LArSoft TPC ID
cstat	the LArSoft cryostat ID

Returns: The mapped LArSoft view

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 74 of file ProtoDUNEDualPhase.h.

References lar_pandora::VintageLArTPCThreeView::GetChannelMap(), and geo::WireReadoutGeom::Plane().

Referenced by CreateLineGapParametersFromReadoutGaps().

   {
     return this->GetChannelMap().Plane({cstat, tpc, 0}).View();
   }

geo::View_t lar_pandora::ProtoDUNEDualPhase::TargetViewW	(	const geo::TPCID::TPCID_t	tpc,
		const geo::CryostatID::CryostatID_t	cstat
	)		const

inlineoverridevirtual

Map a LArSoft view to Pandora's W view.

Parameters

tpc	the LArSoft TPC ID
cstat	the LArSoft cryostat ID

Returns: The mapped LArSoft view

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 83 of file ProtoDUNEDualPhase.h.

References geo::kUnknown.

   {
     return geo::kUnknown;
   }

float lar_pandora::VintageLArTPCThreeView::WireAngleU	(	const geo::TPCID::TPCID_t	tpc,
		const geo::CryostatID::CryostatID_t	cstat
	)		const

inlineoverridevirtualinherited

The angle of the wires in the mapped U view.

Returns: The mapped wire angle

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 150 of file VintageLArTPCThreeView.h.

References lar_pandora::VintageLArTPCThreeView::m_wireReadoutGeom, lar_pandora::VintageLArTPCThreeView::TargetViewU(), and lar_pandora::detector_functions::WireAngle().

   {
     return detector_functions::WireAngle(TargetViewU(tpc, cstat), tpc, cstat, *m_wireReadoutGeom);
   }

float lar_pandora::VintageLArTPCThreeView::WireAngleV	(	const geo::TPCID::TPCID_t	tpc,
		const geo::CryostatID::CryostatID_t	cstat
	)		const

inlineoverridevirtualinherited

The angle of the wires in the mapped V view.

Returns: The mapped wire angle

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 158 of file VintageLArTPCThreeView.h.

References lar_pandora::VintageLArTPCThreeView::m_wireReadoutGeom, lar_pandora::VintageLArTPCThreeView::TargetViewV(), and lar_pandora::detector_functions::WireAngle().

   {
     return detector_functions::WireAngle(TargetViewV(tpc, cstat), tpc, cstat, *m_wireReadoutGeom);
   }

float lar_pandora::ProtoDUNEDualPhase::WireAngleW	(	const geo::TPCID::TPCID_t	tpc,
		const geo::CryostatID::CryostatID_t	cstat
	)		const

inlineoverridevirtual

The angle of the wires in the mapped V view.

Returns: The mapped wire angle

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 99 of file ProtoDUNEDualPhase.h.

   {
     return std::numeric_limits<float>::epsilon();
   }

float lar_pandora::VintageLArTPCThreeView::WirePitchU ( ) const

inlineoverridevirtualinherited

The wire pitch of the mapped U view.

Returns: The mapped wire pitch

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 129 of file VintageLArTPCThreeView.h.

References lar_pandora::VintageLArTPCThreeView::m_wireReadoutGeom, geo::WireReadoutGeom::Plane(), and lar_pandora::VintageLArTPCThreeView::TargetViewU().

Referenced by WirePitchW().

   {
     return m_wireReadoutGeom->Plane({0, 0}, TargetViewU(0, 0)).WirePitch();
   }

float lar_pandora::VintageLArTPCThreeView::WirePitchV ( ) const

inlineoverridevirtualinherited

The wire pitch of the mapped V view.

Returns: The mapped wire pitch

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 136 of file VintageLArTPCThreeView.h.

References lar_pandora::VintageLArTPCThreeView::m_wireReadoutGeom, geo::WireReadoutGeom::Plane(), and lar_pandora::VintageLArTPCThreeView::TargetViewV().

Referenced by WirePitchW().

   {
     return m_wireReadoutGeom->Plane({0, 0}, TargetViewV(0, 0)).WirePitch();
   }

float lar_pandora::ProtoDUNEDualPhase::WirePitchW ( ) const

inlineoverridevirtual

The wire pitch of the mapped W view.

Returns: The mapped wire pitch

Implements lar_pandora::LArPandoraDetectorType.

Definition at line 92 of file ProtoDUNEDualPhase.h.

References lar_pandora::VintageLArTPCThreeView::WirePitchU(), and lar_pandora::VintageLArTPCThreeView::WirePitchV().

   {
     return 0.5f * (this->WirePitchU() + this->WirePitchV());
   }

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

larpandora/v10_00_14/source/larpandora/LArPandoraInterface/Detectors/ProtoDUNEDualPhase.h
larpandora/v10_00_14/source/larpandora/LArPandoraInterface/Detectors/ProtoDUNEDualPhase.cxx

Public Member Functions

Detailed Description

Member Function Documentation