ShowerRecoTools::ShowerPCADirection Class Reference

Inheritance diagram for ShowerRecoTools::ShowerPCADirection:

Public Member Functions
	ShowerPCADirection (const fhicl::ParameterSet &pset)
int	CalculateElement (const art::Ptr< recob::PFParticle > &pfparticle, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder) override
int	RunShowerTool (const art::Ptr< recob::PFParticle > &pfparticle, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder, std::string evd_display_name_append="")
void	SetPtr (art::ProducesCollector *collector)
void	InitaliseProducerPtr (reco::shower::ShowerProducedPtrsHolder &uniqueproducerPtrs)

Protected Member Functions
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 Member Functions
void	InitialiseProducers () override
int	AddAssociations (const art::Ptr< recob::PFParticle > &pfpPtr, art::Event &Event, reco::shower::ShowerElementHolder &ShowerEleHolder) override
recob::PCAxis	CalculateShowerPCA (const detinfo::DetectorClocksData &clockData, const detinfo::DetectorPropertiesData &detProp, const std::vector< art::Ptr< recob::SpacePoint >> &spacePoints_pfp, const art::FindManyP< recob::Hit > &fmh, geo::Point_t &ShowerCentre)
geo::Vector_t	GetPCAxisVector (recob::PCAxis &PCAxis)

Private Attributes
art::InputTag	fPFParticleLabel
int	fVerbose
unsigned int	fNSegments
bool	fUseStartPosition
bool	fChargeWeighted
std::string	fShowerStartPositionInputLabel
std::string	fShowerDirectionOutputLabel
std::string	fShowerCentreOutputLabel
std::string	fShowerPCAOutputLabel

Detailed Description

Definition at line 28 of file ShowerPCADirection_tool.cc.

Constructor & Destructor Documentation

ShowerRecoTools::ShowerPCADirection::ShowerPCADirection

(

const fhicl::ParameterSet &

pset

)

Definition at line 71 of file ShowerPCADirection_tool.cc.

    : IShowerTool(pset.get<fhicl::ParameterSet>("BaseTools"))
    , fPFParticleLabel(pset.get<art::InputTag>("PFParticleLabel"))
    , fVerbose(pset.get<int>("Verbose"))
    , fNSegments(pset.get<unsigned int>("NSegments"))
    , fUseStartPosition(pset.get<bool>("UseStartPosition"))
    , fChargeWeighted(pset.get<bool>("ChargeWeighted"))
    , fShowerStartPositionInputLabel(pset.get<std::string>("ShowerStartPositionInputLabel"))
    , fShowerDirectionOutputLabel(pset.get<std::string>("ShowerDirectionOutputLabel"))
    , fShowerCentreOutputLabel(pset.get<std::string>("ShowerCentreOutputLabel"))
    , fShowerPCAOutputLabel(pset.get<std::string>("ShowerPCAOutputLabel"))
  {}

Member Function Documentation

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

overrideprivatevirtual

Reimplemented from ShowerRecoTools::IShowerTool.

Definition at line 272 of file ShowerPCADirection_tool.cc.

References reco::shower::ShowerElementHolder::CheckElement(), DEFINE_ART_CLASS_TOOL, fShowerPCAOutputLabel, fVerbose, and ShowerRecoTools::IShowerTool::GetVectorPtrSize().

  {

    //First check the element has been set
    if (!ShowerEleHolder.CheckElement(fShowerPCAOutputLabel)) {
      if (fVerbose) mf::LogError("ShowerPCADirection: Add Assns") << "PCA not set." << std::endl;
      return 1;
    }

    int ptrSize = GetVectorPtrSize(fShowerPCAOutputLabel);

    const art::Ptr<recob::PCAxis> pcaPtr =
      GetProducedElementPtr<recob::PCAxis>(fShowerPCAOutputLabel, ShowerEleHolder, ptrSize - 1);
    const art::Ptr<recob::Shower> showerPtr =
      GetProducedElementPtr<recob::Shower>("shower", ShowerEleHolder);

    AddSingle<art::Assns<recob::Shower, recob::PCAxis>>(showerPtr, pcaPtr, "ShowerPCAxisAssn");
    AddSingle<art::Assns<recob::PFParticle, recob::PCAxis>>(pfpPtr, pcaPtr, "PFParticlePCAxisAssn");

    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::ShowerPCADirection::CalculateElement ( const art::Ptr< recob::PFParticle > &  pfparticle, art::Event &  Event, reco::shower::ShowerElementHolder &  ShowerEleHolder  )

overridevirtual

Implements ShowerRecoTools::IShowerTool.

Definition at line 91 of file ShowerPCADirection_tool.cc.

References CalculateShowerPCA(), reco::shower::ShowerElementHolder::CheckElement(), fNSegments, fPFParticleLabel, fShowerCentreOutputLabel, fShowerDirectionOutputLabel, fShowerPCAOutputLabel, fShowerStartPositionInputLabel, fUseStartPosition, fVerbose, reco::shower::ShowerElementHolder::GetElement(), reco::shower::ShowerElementHolder::GetFindManyP(), ShowerRecoTools::IShowerTool::GetLArPandoraShowerAlg(), GetPCAxisVector(), art::ProductRetriever::getValidHandle(), art::Ptr< T >::key(), shower::LArPandoraShowerAlg::RMSShowerGradient(), and reco::shower::ShowerElementHolder::SetElement().

  {

    // Get the assocated pfParicle vertex PFParticles
    auto const pfpHandle = Event.getValidHandle<std::vector<recob::PFParticle>>(fPFParticleLabel);

    const art::FindManyP<recob::SpacePoint>& fmspp =
      ShowerEleHolder.GetFindManyP<recob::SpacePoint>(pfpHandle, Event, fPFParticleLabel);

    //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);

    //SpacePoints
    std::vector<art::Ptr<recob::SpacePoint>> spacePoints_pfp = fmspp.at(pfparticle.key());

    //We cannot progress with no spacepoints.
    if (spacePoints_pfp.size() < 3) {
      mf::LogWarning("ShowerPCADirection")
        << spacePoints_pfp.size() << " spacepoints in shower, not calculating direction"
        << 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 ShowerCentre;
    recob::PCAxis PCA = CalculateShowerPCA(clockData, detProp, spacePoints_pfp, fmh, ShowerCentre);
    auto PCADirection = GetPCAxisVector(PCA);

    //Save the shower the center for downstream tools
    geo::Point_t ShowerCentreErr = {-999, -999, -999};
    ShowerEleHolder.SetElement(ShowerCentre, ShowerCentreErr, fShowerCentreOutputLabel);
    ShowerEleHolder.SetElement(PCA, fShowerPCAOutputLabel);

    //Check if we are pointing the correct direction or not, First try the start position
    if (fUseStartPosition) {
      if (!ShowerEleHolder.CheckElement(fShowerStartPositionInputLabel)) {
        if (fVerbose)
          mf::LogError("ShowerPCADirection")
            << "fUseStartPosition is set but ShowerStartPosition is not set. Bailing" << std::endl;
        return 1;
      }
      //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);

      // Calculate the general direction of the shower
      auto const GeneralDir = (ShowerCentre - StartPositionVec).Unit();

      //Calculate the dot product between eigenvector and general direction
      double DotProduct = PCADirection.Dot(GeneralDir);

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

      //To do
      geo::Vector_t PCADirectionErr = {-999, -999, -999};
      ShowerEleHolder.SetElement(PCADirection, PCADirectionErr, fShowerDirectionOutputLabel);
      return 0;
    }

    //Otherwise Check against the RMS of the shower. Method adapated from EMShower Thanks Mike.
    double RMSGradient = IShowerTool::GetLArPandoraShowerAlg().RMSShowerGradient(
      spacePoints_pfp, ShowerCentre, PCADirection, fNSegments);

    // If the alg fails to calculate the gradient it will return 0. In this case do nothing
    // If the gradient is negative, flip the direction of the shower
    if (RMSGradient < -std::numeric_limits<double>::epsilon()) { PCADirection *= -1; }

    //To do
    geo::Vector_t PCADirectionErr = {-999, -999, -999};

    ShowerEleHolder.SetElement(PCADirection, PCADirectionErr, fShowerDirectionOutputLabel);
    return 0;
  }

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

private

Definition at line 177 of file ShowerPCADirection_tool.cc.

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

Referenced by CalculateElement().

  {

    float TotalCharge = 0;
    float sumWeights = 0;
    float xx = 0;
    float yy = 0;
    float zz = 0;
    float xy = 0;
    float xz = 0;
    float yz = 0;

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

    //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);
      }

      xx += sp_position.X() * sp_position.X() * wht;
      yy += sp_position.Y() * sp_position.Y() * wht;
      zz += sp_position.Z() * sp_position.Z() * wht;
      xy += sp_position.X() * sp_position.Y() * wht;
      xz += sp_position.X() * sp_position.Z() * wht;
      yz += sp_position.Y() * sp_position.Z() * wht;
      sumWeights += wht;
    }

    // Using Eigen package
    Eigen::Matrix3f matrix;

    // Construct covariance matrix
    matrix << xx, xy, xz, xy, yy, yz, xz, yz, zz;

    // Normalise from the sum of weights
    matrix /= sumWeights;

    // Run the PCA
    Eigen::SelfAdjointEigenSolver<Eigen::Matrix3f> eigenMatrix(matrix);

    Eigen::Vector3f eigenValuesVector = eigenMatrix.eigenvalues();
    Eigen::Matrix3f eigenVectorsMatrix = eigenMatrix.eigenvectors();

    // Put in the required form for a recob::PCAxis
    const bool svdOk = true; //TODO: Should probably think about this a bit more
    const int nHits = sps.size();
    // For some reason eigen sorts the eigenvalues from smallest to largest, reverse it
    const double eigenValues[3] = {
      eigenValuesVector(2), eigenValuesVector(1), eigenValuesVector(0)};
    std::vector<std::vector<double>> eigenVectors = {
      {eigenVectorsMatrix(0, 2), eigenVectorsMatrix(1, 2), eigenVectorsMatrix(2, 2)},
      {eigenVectorsMatrix(0, 1), eigenVectorsMatrix(1, 1), eigenVectorsMatrix(2, 1)},
      {eigenVectorsMatrix(0, 0), eigenVectorsMatrix(1, 0), eigenVectorsMatrix(2, 0)}};
    const double avePos[3] = {ShowerCentre.X(), ShowerCentre.Y(), ShowerCentre.Z()};

    return recob::PCAxis(svdOk, nHits, eigenValues, eigenVectors, avePos);
  }

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(), CalculateElement(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), CalculateShowerPCA(), ShowerRecoTools::Shower2DLinearRegressionTrackHitFinder::FindInitialTrackHits(), ShowerRecoTools::Shower3DCylinderTrackHitFinder::FindTrackSpacePoints(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::FitSegmentAndCalculateResidual(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::PruneFrontOfSPSPool(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::PruneTrack(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::RunTestOfIncrementalSpacePointFinder(), ShowerRecoTools::ShowerTrackPCADirection::ShowerPCAVector(), and ShowerRecoTools::ShowerIncrementalTrackHitFinder::ShowerPCAVector().

    {
      return fLArPandoraShowerAlg;
    };

geo::Vector_t ShowerRecoTools::ShowerPCADirection::GetPCAxisVector ( recob::PCAxis &  PCAxis )

private

Definition at line 265 of file ShowerPCADirection_tool.cc.

References recob::PCAxis::getEigenVectors().

Referenced by CalculateElement().

  {
    //Get the Eigenvectors.
    std::vector<double> EigenVector = PCAxis.getEigenVectors()[0];
    return {EigenVector[0], EigenVector[1], EigenVector[2]};
  }

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 AddAssociations().

{ return UniquePtrs->GetVectorPtrSize(Name); }

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

inlineinherited

Definition at line 68 of file IShowerTool.h.

    {
      UniquePtrs = &uniqueproducerPtrs;
    }

void ShowerRecoTools::ShowerPCADirection::InitialiseProducers ( )

overrideprivatevirtual

Reimplemented from ShowerRecoTools::IShowerTool.

Definition at line 84 of file ShowerPCADirection_tool.cc.

References fShowerPCAOutputLabel.

  {
    InitialiseProduct<std::vector<recob::PCAxis>>(fShowerPCAOutputLabel);
    InitialiseProduct<art::Assns<recob::Shower, recob::PCAxis>>("ShowerPCAxisAssn");
    InitialiseProduct<art::Assns<recob::PFParticle, recob::PCAxis>>("PFParticlePCAxisAssn");
  }

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

Member Data Documentation

bool ShowerRecoTools::ShowerPCADirection::fChargeWeighted

private

Definition at line 63 of file ShowerPCADirection_tool.cc.

Referenced by CalculateShowerPCA().

unsigned int ShowerRecoTools::ShowerPCADirection::fNSegments

private

Definition at line 60 of file ShowerPCADirection_tool.cc.

Referenced by CalculateElement().

art::InputTag ShowerRecoTools::ShowerPCADirection::fPFParticleLabel

private

Definition at line 57 of file ShowerPCADirection_tool.cc.

Referenced by CalculateElement().

std::string ShowerRecoTools::ShowerPCADirection::fShowerCentreOutputLabel

private

Definition at line 67 of file ShowerPCADirection_tool.cc.

Referenced by CalculateElement().

std::string ShowerRecoTools::ShowerPCADirection::fShowerDirectionOutputLabel

private

Definition at line 66 of file ShowerPCADirection_tool.cc.

Referenced by CalculateElement().

std::string ShowerRecoTools::ShowerPCADirection::fShowerPCAOutputLabel

private

Definition at line 68 of file ShowerPCADirection_tool.cc.

Referenced by AddAssociations(), CalculateElement(), and InitialiseProducers().

std::string ShowerRecoTools::ShowerPCADirection::fShowerStartPositionInputLabel

private

Definition at line 65 of file ShowerPCADirection_tool.cc.

Referenced by CalculateElement().

bool ShowerRecoTools::ShowerPCADirection::fUseStartPosition

private

Definition at line 61 of file ShowerPCADirection_tool.cc.

Referenced by CalculateElement().

int ShowerRecoTools::ShowerPCADirection::fVerbose

private

Definition at line 58 of file ShowerPCADirection_tool.cc.

Referenced by AddAssociations(), and CalculateElement().

---

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

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