VintageLArTPCThreeView.h

Go to the documentation of this file.

/**
 *  @file   larpandora/LArPandoraInterface/Detectors/VintageLArTPCThreeView.h
 *
 *  @brief  Detector interface for an older-style 3view, horizontal drift, single-phase LArTPC (e.g. MicroBooNE, DUNEFD-HD, PDSP etc)
 *
 *  $Log: $
 */

#ifndef LAR_PANDORA_DETECTOR_VINTAGE_LAR_TPC_THREE_VIEW_H
#define LAR_PANDORA_DETECTOR_VINTAGE_LAR_TPC_THREE_VIEW_H 1

#include "larpandora/LArPandoraInterface/Detectors/LArPandoraDetectorType.h"
#include "larpandora/LArPandoraInterface/LArPandoraGeometryComponents.h"

#include "Api/PandoraApi.h"
#include "Managers/PluginManager.h"
#include "Pandora/Pandora.h"
#include "Plugins/LArTransformationPlugin.h"

#include "larcore/Geometry/Geometry.h"
#include "art/Framework/Services/Registry/ServiceHandle.h"

namespace lar_pandora {

  /**
     *  @brief  Detector interface for a 3view, horizontal drift, single-phase LArTPC
     */
  class VintageLArTPCThreeView : public LArPandoraDetectorType {
  public:
    virtual geo::View_t TargetViewU(const geo::TPCID::TPCID_t tpc,
                                    const geo::CryostatID::CryostatID_t cstat) const override;

    virtual geo::View_t TargetViewV(const geo::TPCID::TPCID_t tpc,
                                    const geo::CryostatID::CryostatID_t cstat) const override;

    virtual geo::View_t TargetViewW(const geo::TPCID::TPCID_t tpc,
                                    const geo::CryostatID::CryostatID_t cstat) const override;

    virtual float WirePitchU() const override;

    virtual float WirePitchV() const override;

    virtual float WirePitchW() const override;

    virtual float WireAngleU(const geo::TPCID::TPCID_t tpc,
                             const geo::CryostatID::CryostatID_t cstat) const override;

    virtual float WireAngleV(const geo::TPCID::TPCID_t tpc,
                             const geo::CryostatID::CryostatID_t cstat) const override;

    virtual float WireAngleW(const geo::TPCID::TPCID_t tpc,
                             const geo::CryostatID::CryostatID_t cstat) const override;

    virtual bool CheckDetectorGapSize(const geo::Vector_t& gaps,
                                      const geo::Vector_t& deltas,
                                      const float maxDisplacement) const override;

    virtual LArDetectorGap CreateDetectorGap(const geo::Point_t& point1,
                                             const geo::Point_t& point2,
                                             const geo::Vector_t& widths) const override;

    virtual void LoadDaughterDetectorGaps(const LArDriftVolume& driftVolume,
                                          const float maxDisplacement,
                                          LArDetectorGapList& listOfGaps) const override;

    virtual PandoraApi::Geometry::LineGap::Parameters CreateLineGapParametersFromDetectorGaps(
      const LArDetectorGap& gap) const override;

    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 override;

    /**
             *  @brief  Loan the LArSoft geometry handle owned by this class
             *
             *  @result The LArSoft geometry handle
             */
    const art::ServiceHandle<geo::Geometry>& GetLArSoftGeometry() const;

  private:
    art::ServiceHandle<geo::Geometry> m_LArSoftGeometry; ///< the LArSoft geometry handle
  };

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline geo::View_t
  VintageLArTPCThreeView::TargetViewU(const geo::TPCID::TPCID_t tpc,
                                      const geo::CryostatID::CryostatID_t cstat) const
  {
    return (m_LArSoftGeometry->TPC(tpc, cstat).DriftDirection() == geo::kPosX ?
              m_LArSoftGeometry->View(geo::PlaneID(cstat, tpc, 1)) :
              m_LArSoftGeometry->View(geo::PlaneID(cstat, tpc, 0)));
  }

  inline geo::View_t
  VintageLArTPCThreeView::TargetViewV(const geo::TPCID::TPCID_t tpc,
                                      const geo::CryostatID::CryostatID_t cstat) const
  {
    return (m_LArSoftGeometry->TPC(tpc, cstat).DriftDirection() == geo::kPosX ?
              m_LArSoftGeometry->View(geo::PlaneID(cstat, tpc, 0)) :
              m_LArSoftGeometry->View(geo::PlaneID(cstat, tpc, 1)));
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline geo::View_t
  VintageLArTPCThreeView::TargetViewW(const geo::TPCID::TPCID_t tpc,
                                      const geo::CryostatID::CryostatID_t cstat) const
  {
    return m_LArSoftGeometry->View(geo::PlaneID(cstat, tpc, 2));
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline float
  VintageLArTPCThreeView::WirePitchU() const
  {
    return m_LArSoftGeometry->WirePitch(this->TargetViewU(0, 0));
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline float
  VintageLArTPCThreeView::WirePitchV() const
  {
    return m_LArSoftGeometry->WirePitch(this->TargetViewV(0, 0));
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline float
  VintageLArTPCThreeView::WirePitchW() const
  {
    return m_LArSoftGeometry->WirePitch(this->TargetViewW(0, 0));
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline float
  VintageLArTPCThreeView::WireAngleU(const geo::TPCID::TPCID_t tpc,
                                     const geo::CryostatID::CryostatID_t cstat) const
  {
    return detector_functions::WireAngle(
      this->TargetViewU(tpc, cstat), tpc, cstat, m_LArSoftGeometry);
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline float
  VintageLArTPCThreeView::WireAngleV(const geo::TPCID::TPCID_t tpc,
                                     const geo::CryostatID::CryostatID_t cstat) const
  {
    return detector_functions::WireAngle(
      this->TargetViewV(tpc, cstat), tpc, cstat, m_LArSoftGeometry);
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline float
  VintageLArTPCThreeView::WireAngleW(const geo::TPCID::TPCID_t tpc,
                                     const geo::CryostatID::CryostatID_t cstat) const
  {
    return detector_functions::WireAngle(
      this->TargetViewW(tpc, cstat), tpc, cstat, m_LArSoftGeometry);
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline bool
  VintageLArTPCThreeView::CheckDetectorGapSize(const geo::Vector_t& gaps,
                                               const geo::Vector_t& deltas,
                                               const float maxDisplacement) const
  {
    if (gaps.X() < 0.f || gaps.X() > maxDisplacement || deltas.Y() > maxDisplacement ||
        deltas.Z() > maxDisplacement)
      return false;
    return true;
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline LArDetectorGap
  VintageLArTPCThreeView::CreateDetectorGap(const geo::Point_t& point1,
                                            const geo::Point_t& point2,
                                            const geo::Vector_t& widths) const
  {
    return LArDetectorGap(point1.X(), point1.Y(), point1.Z(), point2.X(), point2.Y(), point2.Z());
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline void
  VintageLArTPCThreeView::LoadDaughterDetectorGaps(const LArDriftVolume& driftVolume,
                                                   const float maxDisplacement,
                                                   LArDetectorGapList& listOfGaps) const
  {
    return;
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline PandoraApi::Geometry::LineGap::Parameters
  VintageLArTPCThreeView::CreateLineGapParametersFromDetectorGaps(const LArDetectorGap& gap) const
  {
    return detector_functions::CreateDriftGapParameters(gap);
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline PandoraApi::Geometry::LineGap::Parameters
  VintageLArTPCThreeView::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
  {
    float first(0.f), last(0.f);
    pandora::LineGapType gapType(pandora::TPC_DRIFT_GAP);
    if (view == this->TargetViewW(tpc, cstat)) {
      first = firstXYZ[2];
      last = lastXYZ[2];
      gapType = pandora::TPC_WIRE_GAP_VIEW_W;
    }
    else if (view == this->TargetViewU(tpc, cstat)) {
      first = pPandora->GetPlugins()->GetLArTransformationPlugin()->YZtoU(firstXYZ[1], firstXYZ[2]);
      last = pPandora->GetPlugins()->GetLArTransformationPlugin()->YZtoU(lastXYZ[1], lastXYZ[2]);
      gapType = pandora::TPC_WIRE_GAP_VIEW_U;
    }
    else if (view == this->TargetViewV(tpc, cstat)) {
      first = pPandora->GetPlugins()->GetLArTransformationPlugin()->YZtoV(firstXYZ[1], firstXYZ[2]);
      last = pPandora->GetPlugins()->GetLArTransformationPlugin()->YZtoV(lastXYZ[1], lastXYZ[2]);
      gapType = pandora::TPC_WIRE_GAP_VIEW_V;
    }
    return detector_functions::CreateReadoutGapParameters(
      first, last, xFirst, xLast, halfWirePitch, gapType);
  }

  //------------------------------------------------------------------------------------------------------------------------------------------

  inline const art::ServiceHandle<geo::Geometry>&
  VintageLArTPCThreeView::GetLArSoftGeometry() const
  {
    return m_LArSoftGeometry;
  }

} // namespace lar_pandora
#endif // #ifndef LAR_PANDORA_DETECTOR_VINTAGE_LAR_TPC_THREE_VIEW_H