Public Member Functions | List of all members
lar_pandora::LArPandoraDetectorType Class Referenceabstract

Empty interface to map pandora to specifics in the LArSoft geometry. More...

#include <LArPandoraDetectorType.h>

Inheritance diagram for lar_pandora::LArPandoraDetectorType:
lar_pandora::VintageLArTPCThreeView lar_pandora::DUNEFarDetVDThreeView lar_pandora::ICARUS lar_pandora::ProtoDUNEDualPhase

Public Member Functions

virtual geo::View_t TargetViewU (const geo::TPCID::TPCID_t tpc, const geo::CryostatID::CryostatID_t cstat) const =0
 Map a LArSoft view to Pandora's U view. More...
 
virtual geo::View_t TargetViewV (const geo::TPCID::TPCID_t tpc, const geo::CryostatID::CryostatID_t cstat) const =0
 Map a LArSoft view to Pandora's V view. More...
 
virtual geo::View_t TargetViewW (const geo::TPCID::TPCID_t tpc, const geo::CryostatID::CryostatID_t cstat) const =0
 Map a LArSoft view to Pandora's W view. More...
 
virtual float WirePitchU () const =0
 The wire pitch of the mapped U view. More...
 
virtual float WirePitchV () const =0
 The wire pitch of the mapped V view. More...
 
virtual float WirePitchW () const =0
 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 =0
 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 =0
 The angle of the wires in the mapped V view. More...
 
virtual float WireAngleW (const geo::TPCID::TPCID_t tpc, const geo::CryostatID::CryostatID_t cstat) const =0
 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 =0
 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 =0
 Create a detector gap. More...
 
virtual void LoadDaughterDetectorGaps (const LArDriftVolume &driftVolume, const float maxDisplacement, LArDetectorGapList &listOfGaps) const =0
 Create detector gaps for all daughter volumes in a logical TPC volume. More...
 
virtual PandoraApi::Geometry::LineGap::Parameters CreateLineGapParametersFromDetectorGaps (const LArDetectorGap &gap) const =0
 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 double firstXYZ[3], const double lastXYZ[3], const float halfWirePitch, const float xFirst, const float xLast, const pandora::Pandora *pPandora) const =0
 Create the line gap parameters to give to the pandora API. More...
 

Detailed Description

Empty interface to map pandora to specifics in the LArSoft geometry.

Definition at line 25 of file LArPandoraDetectorType.h.

Member Function Documentation

virtual bool lar_pandora::LArPandoraDetectorType::CheckDetectorGapSize ( const geo::Vector_t gaps,
const geo::Vector_t deltas,
const float  maxDisplacement 
) const
pure virtual

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

Parameters
gapsa cartesean vector holding gap sizes between adjacent TPCs
deltasa cartesean vector holding distances between adjacent TPCs
maxDisplacementthe gap size threshold
Returns
logic bool

Implemented in lar_pandora::VintageLArTPCThreeView, and lar_pandora::ProtoDUNEDualPhase.

virtual LArDetectorGap lar_pandora::LArPandoraDetectorType::CreateDetectorGap ( const geo::Point_t point1,
const geo::Point_t point2,
const geo::Vector_t widths 
) const
pure virtual

Create a detector gap.

Parameters
point1a point on TPC1 that are closest to TPC2
point2a point on TPC2 that are closest to TPC1
widththe gap sizes
Returns
the detector gap object

Implemented in lar_pandora::VintageLArTPCThreeView, and lar_pandora::ProtoDUNEDualPhase.

virtual PandoraApi::Geometry::LineGap::Parameters lar_pandora::LArPandoraDetectorType::CreateLineGapParametersFromDetectorGaps ( const LArDetectorGap gap) const
pure virtual

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

Parameters
gapthe input detector gap
Returns
the pandora API's line gap parameters object

Implemented in lar_pandora::VintageLArTPCThreeView, and lar_pandora::ProtoDUNEDualPhase.

virtual PandoraApi::Geometry::LineGap::Parameters lar_pandora::LArPandoraDetectorType::CreateLineGapParametersFromReadoutGaps ( const geo::View_t  view,
const geo::TPCID::TPCID_t  tpc,
const geo::CryostatID::CryostatID_t  cstat,
const double  firstXYZ[3],
const double  lastXYZ[3],
const float  halfWirePitch,
const float  xFirst,
const float  xLast,
const pandora::Pandora *  pPandora 
) const
pure virtual

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

Parameters
viewthe LArSoft view
tpcthe LArSoft TPC ID
cstatthe LArSoft cryostat ID
firstXYZthe first 3D coordinate
lastXYZthe last 3D coordinate
halfWirePitchthe half wire pitch
pPandorathe pandora instance
xFirstthe min X of the gap
xLastthe max X of the gap
Returns
the pandora API's line gap parameters object

Implemented in lar_pandora::VintageLArTPCThreeView, and lar_pandora::ProtoDUNEDualPhase.

virtual void lar_pandora::LArPandoraDetectorType::LoadDaughterDetectorGaps ( const LArDriftVolume driftVolume,
const float  maxDisplacement,
LArDetectorGapList listOfGaps 
) const
pure virtual

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

Parameters
driftVolumethe parent drift volume
maxDisplacementthe gap size threshold
listOfGapsthe gaps vector to be filled

Implemented in lar_pandora::VintageLArTPCThreeView, and lar_pandora::ProtoDUNEDualPhase.

virtual geo::View_t lar_pandora::LArPandoraDetectorType::TargetViewU ( const geo::TPCID::TPCID_t  tpc,
const geo::CryostatID::CryostatID_t  cstat 
) const
pure virtual

Map a LArSoft view to Pandora's U view.

Parameters
tpcthe LArSoft TPC ID
cstatthe LArSoft cryostat ID
Returns
The mapped LArSoft view

Implemented in lar_pandora::VintageLArTPCThreeView, lar_pandora::DUNEFarDetVDThreeView, lar_pandora::ICARUS, and lar_pandora::ProtoDUNEDualPhase.

virtual geo::View_t lar_pandora::LArPandoraDetectorType::TargetViewV ( const geo::TPCID::TPCID_t  tpc,
const geo::CryostatID::CryostatID_t  cstat 
) const
pure virtual

Map a LArSoft view to Pandora's V view.

Parameters
tpcthe LArSoft TPC ID
cstatthe LArSoft cryostat ID
Returns
The mapped LArSoft view

Implemented in lar_pandora::VintageLArTPCThreeView, lar_pandora::DUNEFarDetVDThreeView, lar_pandora::ICARUS, and lar_pandora::ProtoDUNEDualPhase.

virtual geo::View_t lar_pandora::LArPandoraDetectorType::TargetViewW ( const geo::TPCID::TPCID_t  tpc,
const geo::CryostatID::CryostatID_t  cstat 
) const
pure virtual

Map a LArSoft view to Pandora's W view.

Parameters
tpcthe LArSoft TPC ID
cstatthe LArSoft cryostat ID
Returns
The mapped LArSoft view

Implemented in lar_pandora::VintageLArTPCThreeView, lar_pandora::DUNEFarDetVDThreeView, lar_pandora::ICARUS, and lar_pandora::ProtoDUNEDualPhase.

virtual float lar_pandora::LArPandoraDetectorType::WireAngleU ( const geo::TPCID::TPCID_t  tpc,
const geo::CryostatID::CryostatID_t  cstat 
) const
pure virtual

The angle of the wires in the mapped U view.

Returns
The mapped wire angle

Implemented in lar_pandora::VintageLArTPCThreeView.

virtual float lar_pandora::LArPandoraDetectorType::WireAngleV ( const geo::TPCID::TPCID_t  tpc,
const geo::CryostatID::CryostatID_t  cstat 
) const
pure virtual

The angle of the wires in the mapped V view.

Returns
The mapped wire angle

Implemented in lar_pandora::VintageLArTPCThreeView.

virtual float lar_pandora::LArPandoraDetectorType::WireAngleW ( const geo::TPCID::TPCID_t  tpc,
const geo::CryostatID::CryostatID_t  cstat 
) const
pure virtual

The angle of the wires in the mapped V view.

Returns
The mapped wire angle

Implemented in lar_pandora::VintageLArTPCThreeView, lar_pandora::ProtoDUNEDualPhase, and lar_pandora::ICARUS.

virtual float lar_pandora::LArPandoraDetectorType::WirePitchU ( ) const
pure virtual

The wire pitch of the mapped U view.

Returns
The mapped wire pitch

Implemented in lar_pandora::VintageLArTPCThreeView.

virtual float lar_pandora::LArPandoraDetectorType::WirePitchV ( ) const
pure virtual

The wire pitch of the mapped V view.

Returns
The mapped wire pitch

Implemented in lar_pandora::VintageLArTPCThreeView.

virtual float lar_pandora::LArPandoraDetectorType::WirePitchW ( ) const
pure virtual

The wire pitch of the mapped W view.

Returns
The mapped wire pitch

Implemented in lar_pandora::VintageLArTPCThreeView, and lar_pandora::ProtoDUNEDualPhase.


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