Detector interface for ICARUS. More...

#include "ICARUS.h"

Inheritance diagram for lar_pandora::ICARUS:

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	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...

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

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

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

virtual 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...

virtual 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...

virtual 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...

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

virtual 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...

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

virtual 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...

const art::ServiceHandle< geo::Geometry > &	GetLArSoftGeometry () const
	Loan the LArSoft geometry handle owned by this class. More...

Detailed Description

Detector interface for ICARUS.

Definition at line 20 of file ICARUS.h.

Member Function Documentation

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

inlineoverridevirtualinherited

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.

Reimplemented in lar_pandora::ProtoDUNEDualPhase.

Definition at line 172 of file VintageLArTPCThreeView.h.

   {
     if (gaps.X() < 0.f || gaps.X() > maxDisplacement || deltas.Y() > maxDisplacement ||
         deltas.Z() > maxDisplacement)
       return false;
     return true;
   }

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

inlineoverridevirtualinherited

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.

Reimplemented in lar_pandora::ProtoDUNEDualPhase.

Definition at line 184 of file VintageLArTPCThreeView.h.

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

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

inlineoverridevirtualinherited

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.

Reimplemented in lar_pandora::ProtoDUNEDualPhase.

Definition at line 203 of file VintageLArTPCThreeView.h.

References lar_pandora::detector_functions::CreateDriftGapParameters().

   {
     return detector_functions::CreateDriftGapParameters(gap);
   }

PandoraApi::Geometry::LineGap::Parameters lar_pandora::VintageLArTPCThreeView::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

inlineoverridevirtualinherited

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.

Reimplemented in lar_pandora::ProtoDUNEDualPhase.

Definition at line 211 of file VintageLArTPCThreeView.h.

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

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

const art::ServiceHandle< geo::Geometry > & lar_pandora::VintageLArTPCThreeView::GetLArSoftGeometry ( ) const

inlineinherited

Loan the LArSoft geometry handle owned by this class.

Returns: The LArSoft geometry handle

Definition at line 247 of file VintageLArTPCThreeView.h.

References lar_pandora::VintageLArTPCThreeView::m_LArSoftGeometry.

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

   {
     return m_LArSoftGeometry;
   }

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

inlineoverridevirtualinherited

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.

Reimplemented in lar_pandora::ProtoDUNEDualPhase.

Definition at line 193 of file VintageLArTPCThreeView.h.

   {
     return;
   }

geo::View_t lar_pandora::ICARUS::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

Reimplemented from lar_pandora::VintageLArTPCThreeView.

Definition at line 35 of file ICARUS.h.

References lar_pandora::VintageLArTPCThreeView::GetLArSoftGeometry(), and geo::kPosX.

   {
     geo::TPCID const tpcID{cstat, tpc};
     return (this->GetLArSoftGeometry()->TPC(tpcID).DriftDirection() == geo::kPosX ?
               this->GetLArSoftGeometry()->View(geo::PlaneID(tpcID, 1)) :
               this->GetLArSoftGeometry()->View(geo::PlaneID(tpcID, 2)));
   }

geo::View_t lar_pandora::ICARUS::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

Reimplemented from lar_pandora::VintageLArTPCThreeView.

Definition at line 46 of file ICARUS.h.

References lar_pandora::VintageLArTPCThreeView::GetLArSoftGeometry(), and geo::kPosX.

   {
     geo::TPCID const tpcID{cstat, tpc};
     return (this->GetLArSoftGeometry()->TPC(tpcID).DriftDirection() == geo::kPosX ?
               this->GetLArSoftGeometry()->View(geo::PlaneID(tpcID, 2)) :
               this->GetLArSoftGeometry()->View(geo::PlaneID(tpcID, 1)));
   }

geo::View_t lar_pandora::ICARUS::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

Reimplemented from lar_pandora::VintageLArTPCThreeView.

Definition at line 57 of file ICARUS.h.

References lar_pandora::VintageLArTPCThreeView::GetLArSoftGeometry(), and geo::GeometryCore::View().

Referenced by WireAngleW().

   {
     return this->GetLArSoftGeometry()->View(geo::PlaneID(cstat, tpc, 0));
   }

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 145 of file VintageLArTPCThreeView.h.

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

   {
     return detector_functions::WireAngle(
       this->TargetViewU(tpc, cstat), tpc, cstat, m_LArSoftGeometry);
   }

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 154 of file VintageLArTPCThreeView.h.

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

   {
     return detector_functions::WireAngle(
       this->TargetViewV(tpc, cstat), tpc, cstat, m_LArSoftGeometry);
   }

float lar_pandora::ICARUS::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

Reimplemented from lar_pandora::VintageLArTPCThreeView.

Definition at line 65 of file ICARUS.h.

References util::abs(), lar_pandora::VintageLArTPCThreeView::GetLArSoftGeometry(), TargetViewW(), and lar_pandora::detector_functions::WireAngle().

   {
     return std::abs(detector_functions::WireAngle(
       this->TargetViewW(tpc, cstat), tpc, cstat, this->GetLArSoftGeometry()));
   }

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 124 of file VintageLArTPCThreeView.h.

References lar_pandora::VintageLArTPCThreeView::m_LArSoftGeometry, lar_pandora::VintageLArTPCThreeView::TargetViewU(), and geo::GeometryCore::WirePitch().

Referenced by lar_pandora::ProtoDUNEDualPhase::WirePitchW().

   {
     return m_LArSoftGeometry->WirePitch(this->TargetViewU(0, 0));
   }

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 131 of file VintageLArTPCThreeView.h.

References lar_pandora::VintageLArTPCThreeView::m_LArSoftGeometry, lar_pandora::VintageLArTPCThreeView::TargetViewV(), and geo::GeometryCore::WirePitch().

Referenced by lar_pandora::ProtoDUNEDualPhase::WirePitchW().

   {
     return m_LArSoftGeometry->WirePitch(this->TargetViewV(0, 0));
   }

float lar_pandora::VintageLArTPCThreeView::WirePitchW ( ) const

inlineoverridevirtualinherited

The wire pitch of the mapped W view.

Returns: The mapped wire pitch

Implements lar_pandora::LArPandoraDetectorType.

Reimplemented in lar_pandora::ProtoDUNEDualPhase.

Definition at line 138 of file VintageLArTPCThreeView.h.

References lar_pandora::VintageLArTPCThreeView::m_LArSoftGeometry, lar_pandora::VintageLArTPCThreeView::TargetViewW(), and geo::GeometryCore::WirePitch().

   {
     return m_LArSoftGeometry->WirePitch(this->TargetViewW(0, 0));
   }

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

larpandora/v09_22_05/source/larpandora/LArPandoraInterface/Detectors/ICARUS.h

Public Member Functions

Detailed Description

Member Function Documentation