ShowerRecoTools::ShowerTrackPCADirection Class Reference

Inheritance diagram for ShowerRecoTools::ShowerTrackPCADirection:

Public Member Functions
	ShowerTrackPCADirection (const fhicl::ParameterSet &pset)
int	CalculateElement (const art::Ptr< recob::PFParticle > &pfparticle, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder) override

Private Member Functions
geo::Vector_t	ShowerPCAVector (const detinfo::DetectorClocksData &clockData, const detinfo::DetectorPropertiesData &detProp, std::vector< art::Ptr< recob::SpacePoint >> &spacePoints_pfp, const art::FindManyP< recob::Hit > &fmh, geo::Point_t &ShowerCentre)
int	RunShowerTool (const art::Ptr< recob::PFParticle > &pfparticle, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder, std::string evd_display_name_append="")
virtual void	InitialiseProducers ()
void	SetPtr (art::ProducesCollector *collector)
void	InitaliseProducerPtr (reco::shower::ShowerProducedPtrsHolder &uniqueproducerPtrs)
virtual int	AddAssociations (const art::Ptr< recob::PFParticle > &pfpPtr, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder)
const shower::LArPandoraShowerAlg &	GetLArPandoraShowerAlg () const
template<class T >
art::Ptr< T >	GetProducedElementPtr (std::string Name, reco::shower::ShowerElementHolder &ShowerEleHolder, int iter=-1)
template<class T >
void	InitialiseProduct (std::string Name, std::string InstanceName="")
template<class T , class A , class B >
void	AddSingle (A &a, B &b, std::string Name)
int	GetVectorPtrSize (std::string Name)
void	PrintPtrs ()
void	PrintPtr (std::string Name)

Private Attributes
art::InputTag	fPFParticleLabel
art::InputTag	fHitModuleLabel
int	fVerbose
bool	fChargeWeighted
unsigned int	fMinPCAPoints
std::string	fShowerStartPositionInputLabel
std::string	fInitialTrackSpacePointsInputLabel
std::string	fShowerDirectionOutputLabel

Detailed Description

Definition at line 25 of file ShowerTrackPCADirection_tool.cc.

Constructor & Destructor Documentation

ShowerRecoTools::ShowerTrackPCADirection::ShowerTrackPCADirection

(

const fhicl::ParameterSet &

pset

)

Definition at line 54 of file ShowerTrackPCADirection_tool.cc.

    : IShowerTool(pset.get<fhicl::ParameterSet>("BaseTools"))
    , fPFParticleLabel(pset.get<art::InputTag>("PFParticleLabel"))
    , fHitModuleLabel(pset.get<art::InputTag>("HitModuleLabel"))
    , fVerbose(pset.get<int>("Verbose"))
    , fChargeWeighted(pset.get<bool>("ChargeWeighted"))
    , fMinPCAPoints(pset.get<unsigned int>("MinPCAPoints"))
    , fShowerStartPositionInputLabel(pset.get<std::string>("ShowerStartPositionInputLabel"))
    , fInitialTrackSpacePointsInputLabel(pset.get<std::string>("InitialTrackSpacePointsInputLabel"))
    , fShowerDirectionOutputLabel(pset.get<std::string>("ShowerDirectionOutputLabel"))
  {}

Member Function Documentation

virtual int ShowerRecoTools::IShowerTool::AddAssociations ( const art::Ptr< recob::PFParticle > &  pfpPtr, art::Event &  Event, reco::shower::ShowerElementHolder &  ShowerEleHolder  )

inlinevirtualinherited

Reimplemented in ShowerRecoTools::ShowerPCADirection, ShowerRecoTools::ShowerPandoraSlidingFitTrackFinder, ShowerRecoTools::ShowerExampleTool, and ShowerRecoTools::ShowerSkeletonTool.

Definition at line 74 of file IShowerTool.h.

    {
      return 0;
    }

template<class T , class A , class B >

void ShowerRecoTools::IShowerTool::AddSingle ( A &  a, B &  b, std::string  Name  )

inlineprotectedinherited

Definition at line 152 of file IShowerTool.h.

References reco::shower::ShowerProducedPtrsHolder::AddSingle().

    {
      UniquePtrs->AddSingle<T>(a, b, Name);
    }

int ShowerRecoTools::ShowerTrackPCADirection::CalculateElement ( const art::Ptr< recob::PFParticle > &  pfparticle, art::Event &  Event, reco::shower::ShowerElementHolder &  ShowerEleHolder  )

overridevirtual

Implements ShowerRecoTools::IShowerTool.

Definition at line 66 of file ShowerTrackPCADirection_tool.cc.

References reco::shower::ShowerElementHolder::CheckElement(), fInitialTrackSpacePointsInputLabel, fMinPCAPoints, fPFParticleLabel, fShowerDirectionOutputLabel, fShowerStartPositionInputLabel, fVerbose, reco::shower::ShowerElementHolder::GetElement(), reco::shower::ShowerElementHolder::GetFindManyP(), art::ProductRetriever::getValidHandle(), reco::shower::ShowerElementHolder::SetElement(), and ShowerPCAVector().

  {

    if (!ShowerEleHolder.CheckElement(fShowerStartPositionInputLabel)) {
      if (fVerbose)
        mf::LogError("ShowerTrackPCA") << "Start Position not set. Stopping" << std::endl;
      ;
      return 1;
    }
    if (!ShowerEleHolder.CheckElement(fInitialTrackSpacePointsInputLabel)) {
      if (fVerbose)
        mf::LogError("ShowerTrackPCA") << "TrackSpacePoints not set, returning " << std::endl;
      return 1;
    }

    //Get the spacepoints handle and the hit assoication
    auto const spHandle = Event.getValidHandle<std::vector<recob::SpacePoint>>(fPFParticleLabel);

    const art::FindManyP<recob::Hit>& fmh =
      ShowerEleHolder.GetFindManyP<recob::Hit>(spHandle, Event, fPFParticleLabel);

    std::vector<art::Ptr<recob::SpacePoint>> trackSpacePoints;
    ShowerEleHolder.GetElement(fInitialTrackSpacePointsInputLabel, trackSpacePoints);

    //We cannot progress with no spacepoints.
    if (trackSpacePoints.size() < fMinPCAPoints) {
      if (fVerbose)
        mf::LogError("ShowerTrackPCA") << "Not enough spacepoints for PCA, returning " << std::endl;
      return 1;
    }

    auto const clockData =
      art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(Event);
    auto const detProp =
      art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataFor(Event, clockData);

    //Find the PCA vector
    geo::Point_t trackCentre;
    auto Eigenvector = ShowerPCAVector(clockData, detProp, trackSpacePoints, fmh, trackCentre);

    //Get the General direction as the vector between the start position and the centre
    geo::Point_t StartPositionVec = {-999, -999, -999};
    ShowerEleHolder.GetElement(fShowerStartPositionInputLabel, StartPositionVec);
    auto const GeneralDir = (trackCentre - StartPositionVec).Unit();

    //Dot product
    double DotProduct = Eigenvector.Dot(GeneralDir);

    //If the dotproduct is negative the Direction needs Flipping
    if (DotProduct < 0) { Eigenvector *= -1.; }

    geo::Vector_t EigenvectorErr = {-999, -999, -999};
    ShowerEleHolder.SetElement(Eigenvector, EigenvectorErr, fShowerDirectionOutputLabel);

    return 0;
  }

const shower::LArPandoraShowerAlg& ShowerRecoTools::IShowerTool::GetLArPandoraShowerAlg ( ) const

inlineprotectedinherited

Definition at line 82 of file IShowerTool.h.

Referenced by ShowerRecoTools::ShowerLengthPercentile::CalculateElement(), ShowerRecoTools::ShowerUnidirectiondEdx::CalculateElement(), ShowerRecoTools::Shower3DCylinderTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerPCAPropergationStartPosition::CalculateElement(), ShowerRecoTools::Shower2DLinearRegressionTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerPFPVertexStartPosition::CalculateElement(), ShowerRecoTools::ShowerDirectionCheater::CalculateElement(), ShowerRecoTools::ShowerPCADirection::CalculateElement(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), ShowerRecoTools::ShowerPCADirection::CalculateShowerPCA(), ShowerRecoTools::Shower2DLinearRegressionTrackHitFinder::FindInitialTrackHits(), ShowerRecoTools::Shower3DCylinderTrackHitFinder::FindTrackSpacePoints(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::FitSegmentAndCalculateResidual(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::PruneFrontOfSPSPool(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::PruneTrack(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::RunTestOfIncrementalSpacePointFinder(), ShowerPCAVector(), and ShowerRecoTools::ShowerIncrementalTrackHitFinder::ShowerPCAVector().

    {
      return fLArPandoraShowerAlg;
    };

template<class T >

art::Ptr<T> ShowerRecoTools::IShowerTool::GetProducedElementPtr ( std::string  Name, reco::shower::ShowerElementHolder &  ShowerEleHolder, int  iter = -1  )

inlineprotectedinherited

Definition at line 102 of file IShowerTool.h.

References reco::shower::ShowerElementHolder::CheckElement(), reco::shower::ShowerProducedPtrsHolder::CheckUniqueProduerPtr(), reco::shower::ShowerProducedPtrsHolder::GetArtPtr(), and reco::shower::ShowerElementHolder::GetShowerNumber().

    {

      //Check the element has been set
      bool check_element = ShowerEleHolder.CheckElement(Name);
      if (!check_element) {
        throw cet::exception("IShowerTool") << "tried to get a element that does not exist. Failed "
                                               "at making the art ptr for Element: "
                                            << Name << std::endl;
      }

      //Check the unique ptr has been set.
      bool check_ptr = UniquePtrs->CheckUniqueProduerPtr(Name);
      if (!check_ptr) {
        throw cet::exception("IShowerTool")
          << "tried to get a ptr that does not exist. Failed at making the art ptr for Element"
          << Name;
      }

      //Check if the user has defined an index if not just use the current shower index/
      int index;
      if (iter != -1) { index = iter; }
      else {
        index = ShowerEleHolder.GetShowerNumber();
      }

      //Make the ptr
      return UniquePtrs->GetArtPtr<T>(Name, index);
    }

int ShowerRecoTools::IShowerTool::GetVectorPtrSize ( std::string  Name )

inlineprotectedinherited

Definition at line 158 of file IShowerTool.h.

References reco::shower::ShowerProducedPtrsHolder::GetVectorPtrSize().

Referenced by ShowerRecoTools::ShowerExampleTool::AddAssociations(), ShowerRecoTools::ShowerPandoraSlidingFitTrackFinder::AddAssociations(), and ShowerRecoTools::ShowerPCADirection::AddAssociations().

{ return UniquePtrs->GetVectorPtrSize(Name); }

void ShowerRecoTools::IShowerTool::InitaliseProducerPtr ( reco::shower::ShowerProducedPtrsHolder &  uniqueproducerPtrs )

inlineinherited

Definition at line 68 of file IShowerTool.h.

    {
      UniquePtrs = &uniqueproducerPtrs;
    }

virtual void ShowerRecoTools::IShowerTool::InitialiseProducers ( )

inlinevirtualinherited

Reimplemented in ShowerRecoTools::ShowerPCADirection, ShowerRecoTools::ShowerPandoraSlidingFitTrackFinder, and ShowerRecoTools::ShowerExampleTool.

Definition at line 62 of file IShowerTool.h.

{}

template<class T >

void ShowerRecoTools::IShowerTool::InitialiseProduct ( std::string  Name, std::string  InstanceName = ""  )

inlineprotectedinherited

Definition at line 137 of file IShowerTool.h.

References art::ProducesCollector::produces(), and reco::shower::ShowerProducedPtrsHolder::SetShowerUniqueProduerPtr().

    {

      if (collectorPtr == nullptr) {
        mf::LogWarning("IShowerTool") << "The art::ProducesCollector ptr has not been set";
        return;
      }

      collectorPtr->produces<T>(InstanceName);
      UniquePtrs->SetShowerUniqueProduerPtr(type<T>(), Name, InstanceName);
    }

void ShowerRecoTools::IShowerTool::PrintPtr ( std::string  Name )

inlineprotectedinherited

Definition at line 162 of file IShowerTool.h.

References reco::shower::ShowerProducedPtrsHolder::PrintPtr().

Referenced by ShowerRecoTools::ShowerExampleTool::CalculateElement().

{ UniquePtrs->PrintPtr(Name); }

void ShowerRecoTools::IShowerTool::PrintPtrs ( )

inlineprotectedinherited

Definition at line 160 of file IShowerTool.h.

References reco::shower::ShowerProducedPtrsHolder::PrintPtrs().

Referenced by ShowerRecoTools::ShowerExampleTool::CalculateElement().

{ UniquePtrs->PrintPtrs(); }

int ShowerRecoTools::IShowerTool::RunShowerTool ( const art::Ptr< recob::PFParticle > &  pfparticle, art::Event &  Event, reco::shower::ShowerElementHolder &  ShowerEleHolder, std::string  evd_display_name_append = ""  )

inlineinherited

Definition at line 46 of file IShowerTool.h.

    {

      int calculation_status = CalculateElement(pfparticle, Event, ShowerEleHolder);
      if (calculation_status != 0) return calculation_status;
      if (fRunEventDisplay) {
        IShowerTool::GetLArPandoraShowerAlg().DebugEVD(
          pfparticle, Event, ShowerEleHolder, evd_display_name_append);
      }
      return calculation_status;
    }

void ShowerRecoTools::IShowerTool::SetPtr ( art::ProducesCollector *  collector )

inlineinherited

Definition at line 65 of file IShowerTool.h.

{ collectorPtr = collector; }

geo::Vector_t ShowerRecoTools::ShowerTrackPCADirection::ShowerPCAVector ( const detinfo::DetectorClocksData &  clockData, const detinfo::DetectorPropertiesData &  detProp, std::vector< art::Ptr< recob::SpacePoint >> &  spacePoints_pfp, const art::FindManyP< recob::Hit > &  fmh, geo::Point_t &  ShowerCentre  )

private

Definition at line 126 of file ShowerTrackPCADirection_tool.cc.

References DEFINE_ART_CLASS_TOOL, detinfo::DetectorPropertiesData::ElectronLifetime(), fChargeWeighted, ShowerRecoTools::IShowerTool::GetLArPandoraShowerAlg(), detinfo::sampling_rate(), shower::LArPandoraShowerAlg::ShowerCentre(), shower::LArPandoraShowerAlg::SpacePointCharge(), and shower::LArPandoraShowerAlg::SpacePointTime().

Referenced by CalculateElement().

  {
    //Initialise the the PCA.
    TPrincipal pca(3, "");

    float TotalCharge = 0;

    //Get the Shower Centre
    ShowerCentre =
      IShowerTool::GetLArPandoraShowerAlg().ShowerCentre(clockData, detProp, sps, fmh, TotalCharge);

    //Normalise the spacepoints, charge weight and add to the PCA.
    for (auto& sp : sps) {

      float wht = 1;

      //Normalise the spacepoint position.
      auto const sp_position = sp->position() - ShowerCentre;

      if (fChargeWeighted) {

        //Get the charge.
        float Charge = IShowerTool::GetLArPandoraShowerAlg().SpacePointCharge(sp, fmh);

        //Get the time of the spacepoint
        float Time = IShowerTool::GetLArPandoraShowerAlg().SpacePointTime(sp, fmh);

        //Correct for the lifetime at the moment.
        Charge *= std::exp((sampling_rate(clockData) * Time) / (detProp.ElectronLifetime() * 1e3));

        //Charge Weight
        wht *= std::sqrt(Charge / TotalCharge);
      }

      double sp_coord[3];
      sp_coord[0] = sp_position.X() * wht;
      sp_coord[1] = sp_position.Y() * wht;
      sp_coord[2] = sp_position.Z() * wht;

      //Add to the PCA
      pca.AddRow(sp_coord);
    }

    //Evaluate the PCA
    pca.MakePrincipals();

    //Get the Eigenvectors.
    const TMatrixD* Eigenvectors = pca.GetEigenVectors();

    return {(*Eigenvectors)[0][0], (*Eigenvectors)[1][0], (*Eigenvectors)[2][0]};
  }

Member Data Documentation

bool ShowerRecoTools::ShowerTrackPCADirection::fChargeWeighted

private

Definition at line 46 of file ShowerTrackPCADirection_tool.cc.

Referenced by ShowerPCAVector().

art::InputTag ShowerRecoTools::ShowerTrackPCADirection::fHitModuleLabel

private

Definition at line 44 of file ShowerTrackPCADirection_tool.cc.

std::string ShowerRecoTools::ShowerTrackPCADirection::fInitialTrackSpacePointsInputLabel

private

Definition at line 50 of file ShowerTrackPCADirection_tool.cc.

Referenced by CalculateElement().

unsigned int ShowerRecoTools::ShowerTrackPCADirection::fMinPCAPoints

private

Definition at line 47 of file ShowerTrackPCADirection_tool.cc.

Referenced by CalculateElement().

art::InputTag ShowerRecoTools::ShowerTrackPCADirection::fPFParticleLabel

private

Definition at line 43 of file ShowerTrackPCADirection_tool.cc.

Referenced by CalculateElement().

std::string ShowerRecoTools::ShowerTrackPCADirection::fShowerDirectionOutputLabel

private

Definition at line 51 of file ShowerTrackPCADirection_tool.cc.

Referenced by CalculateElement().

std::string ShowerRecoTools::ShowerTrackPCADirection::fShowerStartPositionInputLabel

private

Definition at line 49 of file ShowerTrackPCADirection_tool.cc.

Referenced by CalculateElement().

int ShowerRecoTools::ShowerTrackPCADirection::fVerbose

private

Definition at line 45 of file ShowerTrackPCADirection_tool.cc.

Referenced by CalculateElement().

---

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

• larpandora/v09_22_05/source/larpandora/LArPandoraEventBuilding/LArPandoraShower/Tools/ShowerTrackPCADirection_tool.cc