ShowerRecoTools::ShowerTrackDirection Class Reference

Inheritance diagram for ShowerRecoTools::ShowerTrackDirection:

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

Private Member Functions
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
int	fVerbose
bool	fUsePandoraVertex
bool	fUsePositionInfo

Detailed Description

Definition at line 19 of file ShowerTrackDirection_tool.cc.

Constructor & Destructor Documentation

ShowerRecoTools::ShowerTrackDirection::ShowerTrackDirection

(

const fhicl::ParameterSet &

pset

)

Definition at line 40 of file ShowerTrackDirection_tool.cc.

    : IShowerTool(pset.get<fhicl::ParameterSet>("BaseTools"))
    , fVerbose(pset.get<int>("Verbose"))
    , fUsePandoraVertex(pset.get<bool>("UsePandoraVertex"))
    , fUsePositionInfo(pset.get<bool>("UsePositionInfo"))
  {}

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

overridevirtual

Implements ShowerRecoTools::IShowerTool.

Definition at line 47 of file ShowerTrackDirection_tool.cc.

References util::abs(), reco::shower::ShowerElementHolder::CheckElement(), DEFINE_ART_CLASS_TOOL, recob::Track::DirectionAtPoint(), recob::Track::FlagsAtPoint(), fUsePandoraVertex, fUsePositionInfo, fVerbose, reco::shower::ShowerElementHolder::GetElement(), recob::TrajectoryPointFlags::InvalidHitIndex, recob::Track::LocationAtPoint(), recob::TrajectoryPointFlagTraits::NoPoint, recob::Track::NumberTrajectoryPoints(), reco::shower::ShowerElementHolder::SetElement(), recob::Track::Start(), geo::vect::toVector(), X, Y, and Z.

  {

    //Check the Track has been defined
    if (!ShowerEleHolder.CheckElement("InitialTrack")) {
      if (fVerbose) mf::LogError("ShowerTrackDirection") << "Initial track not set" << std::endl;
      return 0;
    }

    //Check the start position is set.
    if (fUsePandoraVertex && !ShowerEleHolder.CheckElement("ShowerStartPosition")) {
      if (fVerbose)
        mf::LogError("ShowerTrackDirection") << "Start position not set, returning " << std::endl;
      return 0;
    }

    //Get the track
    recob::Track InitialTrack;
    ShowerEleHolder.GetElement("InitialTrack", InitialTrack);

    if (fUsePositionInfo) {
      geo::Point_t StartPosition;
      if (fUsePandoraVertex) { ShowerEleHolder.GetElement("ShowerStartPosition", StartPosition); }
      else {
        StartPosition = InitialTrack.Start();
      }

      //Calculate the mean direction and the the standard deviation
      float sumX = 0, sumX2 = 0;
      float sumY = 0, sumY2 = 0;
      float sumZ = 0, sumZ2 = 0;
      for (unsigned int traj = 0; traj < InitialTrack.NumberTrajectoryPoints(); ++traj) {

        //Ignore bogus flags.
        auto flags = InitialTrack.FlagsAtPoint(traj);
        if (flags.isSet(recob::TrajectoryPointFlags::InvalidHitIndex) ||
            flags.isSet(recob::TrajectoryPointFlagTraits::NoPoint)) {
          continue;
        }

        //Get the direction to the trajectory position.
        geo::Vector_t TrajPosition = (InitialTrack.LocationAtPoint(traj) - StartPosition).Unit();
        sumX += TrajPosition.X();
        sumX2 += TrajPosition.X() * TrajPosition.X();
        sumY += TrajPosition.Y();
        sumY2 += TrajPosition.Y() * TrajPosition.Y();
        sumZ += TrajPosition.Z();
        sumZ2 += TrajPosition.Z() * TrajPosition.Z();
      }

      float NumTraj = InitialTrack.NumberTrajectoryPoints();
      geo::Vector_t Mean = {sumX / NumTraj, sumY / NumTraj, sumZ / NumTraj};
      Mean = Mean.Unit();

      float RMSX = 999;
      float RMSY = 999;
      float RMSZ = 999;
      if (sumX2 / NumTraj - ((sumX / NumTraj) * ((sumX / NumTraj))) > 0) {
        RMSX = std::sqrt(sumX2 / NumTraj - ((sumX / NumTraj) * ((sumX / NumTraj))));
      }
      if (sumY2 / NumTraj - ((sumY / NumTraj) * ((sumY / NumTraj))) > 0) {
        RMSY = std::sqrt(sumY2 / NumTraj - ((sumY / NumTraj) * ((sumY / NumTraj))));
      }
      if (sumZ2 / NumTraj - ((sumZ / NumTraj) * ((sumZ / NumTraj))) > 0) {
        RMSZ = std::sqrt(sumZ2 / NumTraj - ((sumZ / NumTraj) * ((sumZ / NumTraj))));
      }

      TVector3 Direction_Mean = {0, 0, 0};
      int N = 0;
      //Remove trajectory points from the mean that are not with one sigma.
      for (unsigned int traj = 0; traj < InitialTrack.NumberTrajectoryPoints(); ++traj) {

        //Ignore bogus flags.
        auto flags = InitialTrack.FlagsAtPoint(traj);
        if (flags.isSet(recob::TrajectoryPointFlagTraits::NoPoint)) { continue; }

        //Get the direction of the trajectory point.
        geo::Point_t TrajPosition = InitialTrack.LocationAtPoint(traj);
        geo::Vector_t Direction = (TrajPosition - StartPosition).Unit();

        //Remove points not within 1RMS.
        if (auto MeanSubtractedDir = Direction - Mean; (std::abs(MeanSubtractedDir.X()) < RMSX) &&
                                                       (std::abs(MeanSubtractedDir.Y()) < RMSY) &&
                                                       (std::abs(MeanSubtractedDir.Z()) < RMSZ)) {
          if (Direction.R() == 0) { continue; }
          Direction_Mean += geo::vect::convertTo<TVector3>(Direction);
          ++N;
        }
      }

      //Take the mean value
      if (N > 0) {
        geo::Vector_t Direction = geo::vect::toVector(Direction_Mean.Unit());
        geo::Vector_t DirectionErr = {RMSX, RMSY, RMSZ};
        ShowerEleHolder.SetElement(Direction, DirectionErr, "ShowerDirection");
      }
      else {
        if (fVerbose)
          mf::LogError("ShowerTrackDirection")
            << "None of the points are within 1 sigma" << std::endl;
        return 1;
      }

      return 0;
    }
    else { // if(fUsePositionInfo)

      float sumX = 0, sumX2 = 0;
      float sumY = 0, sumY2 = 0;
      float sumZ = 0, sumZ2 = 0;
      for (unsigned int traj = 0; traj < InitialTrack.NumberTrajectoryPoints(); ++traj) {

        //Ignore bogus points
        auto flags = InitialTrack.FlagsAtPoint(traj);
        if (flags.isSet(recob::TrajectoryPointFlagTraits::NoPoint)) { continue; }

        //Get the direction.
        geo::Vector_t Direction = InitialTrack.DirectionAtPoint(traj);
        sumX += Direction.X();
        sumX2 += Direction.X() * Direction.X();
        sumY += Direction.Y();
        sumY2 += Direction.Y() * Direction.Y();
        sumZ += Direction.Z();
        sumZ2 += Direction.Z() * Direction.Z();
      }

      float NumTraj = InitialTrack.NumberTrajectoryPoints();
      geo::Vector_t Mean = {sumX / NumTraj, sumY / NumTraj, sumZ / NumTraj};
      Mean = Mean.Unit();

      float RMSX = 999;
      float RMSY = 999;
      float RMSZ = 999;
      if (sumX2 / NumTraj - ((sumX / NumTraj) * ((sumX / NumTraj))) > 0) {
        RMSX = std::sqrt(sumX2 / NumTraj - ((sumX / NumTraj) * ((sumX / NumTraj))));
      }
      if (sumY2 / NumTraj - ((sumY / NumTraj) * ((sumY / NumTraj))) > 0) {
        RMSY = std::sqrt(sumY2 / NumTraj - ((sumY / NumTraj) * ((sumY / NumTraj))));
      }
      if (sumZ2 / NumTraj - ((sumZ / NumTraj) * ((sumZ / NumTraj))) > 0) {
        RMSZ = std::sqrt(sumZ2 / NumTraj - ((sumZ / NumTraj) * ((sumZ / NumTraj))));
      }

      //Remove trajectory points from the mean that are not with one sigma.
      float N = 0.;
      TVector3 Direction_Mean = {0, 0, 0};
      for (unsigned int traj = 0; traj < InitialTrack.NumberTrajectoryPoints(); ++traj) {

        auto flags = InitialTrack.FlagsAtPoint(traj);
        if (flags.isSet(recob::TrajectoryPointFlagTraits::NoPoint)) { continue; }

        geo::Vector_t Direction = InitialTrack.DirectionAtPoint(traj).Unit();
        if ((std::abs((Direction - Mean).X()) < 1 * RMSX) &&
            (std::abs((Direction - Mean).Y()) < 1 * RMSY) &&
            (std::abs((Direction - Mean).Z()) < 1 * RMSZ)) {
          TVector3 Direction_vec = {Direction.X(), Direction.Y(), Direction.Z()};
          if (Direction_vec.Mag() == 0) { continue; }
          Direction_Mean += Direction_vec;
          ++N;
        }
      }

      //Take the mean value
      if (N > 0) {
        geo::Vector_t Direction = geo::vect::toVector(Direction_Mean.Unit());
        geo::Vector_t DirectionErr = {RMSX, RMSY, RMSZ};
        ShowerEleHolder.SetElement(Direction, DirectionErr, "ShowerDirection");
      }
      else {
        if (fVerbose)
          mf::LogError("ShowerTrackDirection")
            << "None of the points are within 1 sigma" << std::endl;
        return 1;
      }
    }
    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(), ShowerRecoTools::ShowerTrackPCADirection::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; }

Member Data Documentation

bool ShowerRecoTools::ShowerTrackDirection::fUsePandoraVertex

private

Definition at line 32 of file ShowerTrackDirection_tool.cc.

Referenced by CalculateElement().

bool ShowerRecoTools::ShowerTrackDirection::fUsePositionInfo

private

Definition at line 35 of file ShowerTrackDirection_tool.cc.

Referenced by CalculateElement().

int ShowerRecoTools::ShowerTrackDirection::fVerbose

private

Definition at line 31 of file ShowerTrackDirection_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/ShowerTrackDirection_tool.cc