LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
lar_content::MultiValuedLongitudinalTrackHitsTool Class Reference

MultiValuedLongitudinalTrackHitsTool class. More...

#include "MultiValuedLongitudinalTrackHitsTool.h"

Inheritance diagram for lar_content::MultiValuedLongitudinalTrackHitsTool:
lar_content::LongitudinalTrackHitsBaseTool lar_content::TrackHitsBaseTool lar_content::HitCreationBaseTool

Public Types

typedef ThreeDHitCreationAlgorithm::ProtoHit ProtoHit
 
typedef ThreeDHitCreationAlgorithm::ProtoHitVector ProtoHitVector
 
typedef ThreeDHitCreationAlgorithm::TrajectorySample TrajectorySample
 

Public Member Functions

virtual void Run (ThreeDHitCreationAlgorithm *const pAlgorithm, const pandora::ParticleFlowObject *const pPfo, const pandora::CaloHitVector &inputTwoDHits, ProtoHitVector &protoHitVector)
 Run the algorithm tool. More...
 

Protected Types

typedef std::map< pandora::HitType, TwoDSlidingFitResultMatchedSlidingFitMap
 

Protected Member Functions

virtual void GetTrackHits3D (const pandora::CaloHitVector &inputTwoDHits, const MatchedSlidingFitMap &matchedSlidingFitMap, ProtoHitVector &protoHitVector) const
 Calculate 3D hits from an input list of 2D hits. More...
 
virtual pandora::StatusCode ReadSettings (const pandora::TiXmlHandle xmlHandle)
 
virtual void BuildSlidingFitMap (const pandora::ParticleFlowObject *const pPfo, MatchedSlidingFitMap &matchedSlidingFitMap) const
 Calculate sliding fit results for clusters from each view. More...
 
virtual void GetBestPosition3D (const pandora::HitType hitType1, const pandora::HitType hitType2, const pandora::CartesianPointVector &fitPositionList1, const pandora::CartesianPointVector &fitPositionList2, ProtoHit &protoHit) const
 Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views. More...
 
virtual void GetBestPosition3D (const pandora::HitType hitType1, const pandora::HitType hitType2, const pandora::CartesianVector &fitPosition1, const pandora::CartesianVector &fitPosition2, ProtoHit &protoHit) const
 Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views. More...
 
virtual void GetBestPosition3D (const pandora::HitType hitType, const pandora::CartesianVector &fitPosition, ProtoHit &protoHit) const
 Get the three dimensional position using a provided two dimensional calo hit and a candidate fit position from another view. More...
 

Protected Attributes

unsigned int m_minViews
 The minimum number of views required for building hits. More...
 
unsigned int m_slidingFitWindow
 The layer window for the sliding linear fits. More...
 
double m_sigmaX2
 The sigmaX squared value, for calculation of chi2 deltaX term. More...
 
double m_chiSquaredCut
 The chi squared cut (accept only values below the cut value) More...
 

Private Member Functions

void GetLongitudinalTrackHit3D (const MatchedSlidingFitMap &matchedSlidingFitMap, const pandora::CartesianVector &vtx3D, const pandora::CartesianVector &end3D, ProtoHit &protoHit) const
 Get the three dimensional position using a provided two dimensional calo hit and sliding linear fits in the other two views. More...
 

Detailed Description

Member Typedef Documentation

typedef std::map<pandora::HitType, TwoDSlidingFitResult> lar_content::TrackHitsBaseTool::MatchedSlidingFitMap
protectedinherited

Definition at line 35 of file TrackHitsBaseTool.h.

Member Function Documentation

void lar_content::TrackHitsBaseTool::BuildSlidingFitMap ( const pandora::ParticleFlowObject *const  pPfo,
MatchedSlidingFitMap matchedSlidingFitMap 
) const
protectedvirtualinherited

Calculate sliding fit results for clusters from each view.

Parameters
pPfothe input particle flow object
matchedSlidingFitMapthe group of sliding fit results

Definition at line 57 of file TrackHitsBaseTool.cc.

References lar_content::LArClusterHelper::GetClusterHitType(), lar_content::LArGeometryHelper::GetWirePitch(), lar_content::TrackHitsBaseTool::m_slidingFitWindow, and lar_content::LArClusterHelper::SortByNHits().

Referenced by lar_content::TrackHitsBaseTool::Run().

58 {
59  const ClusterList &pfoClusterList(pPfo->GetClusterList());
60 
61  ClusterVector pfoClusterVector;
62  pfoClusterVector.insert(pfoClusterVector.end(), pfoClusterList.begin(), pfoClusterList.end());
63  std::sort(pfoClusterVector.begin(), pfoClusterVector.end(), LArClusterHelper::SortByNHits);
64 
65  for (const Cluster *const pCluster : pfoClusterVector)
66  {
67  const HitType hitType(LArClusterHelper::GetClusterHitType(pCluster));
68 
69  if (TPC_3D == hitType)
70  continue;
71 
72  if (matchedSlidingFitMap.end() != matchedSlidingFitMap.find(hitType))
73  continue;
74 
75  try
76  {
77  const float slidingFitPitch(LArGeometryHelper::GetWirePitch(this->GetPandora(), LArClusterHelper::GetClusterHitType(pCluster)));
78  const TwoDSlidingFitResult slidingFitResult(pCluster, m_slidingFitWindow, slidingFitPitch);
79 
80  if (!matchedSlidingFitMap.insert(MatchedSlidingFitMap::value_type(hitType, slidingFitResult)).second)
81  throw StatusCodeException(STATUS_CODE_FAILURE);
82  }
83  catch (StatusCodeException &statusCodeException)
84  {
85  if (STATUS_CODE_FAILURE == statusCodeException.GetStatusCode())
86  throw statusCodeException;
87  }
88  }
89 }
static bool SortByNHits(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
Sort clusters by number of hits, then layer span, then inner layer, then position, then pulse-height.
static pandora::HitType GetClusterHitType(const pandora::Cluster *const pCluster)
Get the hit type associated with a two dimensional cluster.
static float GetWirePitch(const pandora::Pandora &pandora, const pandora::HitType view, const float maxWirePitchDiscrepancy=0.01)
Return the wire pitch.
unsigned int m_slidingFitWindow
The layer window for the sliding linear fits.
HitType
Definition: HitType.h:12
std::vector< art::Ptr< recob::Cluster > > ClusterVector
virtual void lar_content::HitCreationBaseTool::GetBestPosition3D ( const pandora::HitType  hitType1,
const pandora::HitType  hitType2,
const pandora::CartesianPointVector &  fitPositionList1,
const pandora::CartesianPointVector &  fitPositionList2,
ProtoHit protoHit 
) const
protectedvirtualinherited

Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views.

Parameters
hitType1the hit type identifying the first view
hitType2the hit type identifying the second view
fitPositionList1the candidate sliding fit position in the first view
fitPositionList2the candidate sliding fit position in the second view
protoHitto receive the populated proto hit

Referenced by lar_content::ThreeViewShowerHitsTool::GetShowerHit3D(), and lar_content::HitCreationBaseTool::~HitCreationBaseTool().

virtual void lar_content::HitCreationBaseTool::GetBestPosition3D ( const pandora::HitType  hitType1,
const pandora::HitType  hitType2,
const pandora::CartesianVector &  fitPosition1,
const pandora::CartesianVector &  fitPosition2,
ProtoHit protoHit 
) const
protectedvirtualinherited

Get the three dimensional position using a provided two dimensional calo hit and candidate fit positions from the other two views.

Parameters
hitType1the hit type identifying the first view
hitType2the hit type identifying the second view
fitPosition1the candidate sliding fit position in the first view
fitPosition2the candidate sliding fit position in the second view
protoHitto receive the populated proto hit
virtual void lar_content::HitCreationBaseTool::GetBestPosition3D ( const pandora::HitType  hitType,
const pandora::CartesianVector &  fitPosition,
ProtoHit protoHit 
) const
protectedvirtualinherited

Get the three dimensional position using a provided two dimensional calo hit and a candidate fit position from another view.

Parameters
hitTypethe hit type identifying the other view
fitPositionthe candidate sliding fit position in the other view
protoHitto receive the populated proto hit
void lar_content::MultiValuedLongitudinalTrackHitsTool::GetLongitudinalTrackHit3D ( const MatchedSlidingFitMap matchedSlidingFitMap,
const pandora::CartesianVector &  vtx3D,
const pandora::CartesianVector &  end3D,
ProtoHit protoHit 
) const
privatevirtual

Get the three dimensional position using a provided two dimensional calo hit and sliding linear fits in the other two views.

Parameters
matchedSlidingFitMapmap of sliding fit results from each view
vtx3Dthe 3D vertex position
end3Dthe 3D end position
protoHitto receive the populated proto hit

Implements lar_content::LongitudinalTrackHitsBaseTool.

Definition at line 20 of file MultiValuedLongitudinalTrackHitsTool.cc.

References f, lar_content::TwoDSlidingFitResult::GetGlobalFitProjection(), and lar_content::ThreeDHitCreationAlgorithm::ProtoHit::GetParentCaloHit2D().

22 {
23  const CaloHit *const pCaloHit2D(protoHit.GetParentCaloHit2D());
24  const HitType hitType(pCaloHit2D->GetHitType());
25  const HitType hitType1((TPC_VIEW_U == hitType) ? TPC_VIEW_V : (TPC_VIEW_V == hitType) ? TPC_VIEW_W : TPC_VIEW_U);
26  const HitType hitType2((TPC_VIEW_U == hitType) ? TPC_VIEW_W : (TPC_VIEW_V == hitType) ? TPC_VIEW_U : TPC_VIEW_V);
27 
28  const CartesianVector vtx2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), vtx3D, hitType));
29  const CartesianVector end2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), end3D, hitType));
30 
31  if ((end2D - vtx2D).GetMagnitudeSquared() < std::numeric_limits<float>::epsilon())
32  throw StatusCodeException(STATUS_CODE_NOT_FOUND);
33 
34  const float frac((end2D - vtx2D).GetDotProduct(pCaloHit2D->GetPositionVector() - vtx2D) / (end2D - vtx2D).GetMagnitudeSquared());
35  const CartesianVector projection3D(vtx3D + (end3D - vtx3D) * frac);
36 
37  CartesianPointVector fitPositionList1, fitPositionList2;
38 
39  MatchedSlidingFitMap::const_iterator fIter1 = matchedSlidingFitMap.find(hitType1);
40  if (matchedSlidingFitMap.end() != fIter1)
41  {
42  const TwoDSlidingFitResult &fitResult1 = fIter1->second;
43  const CartesianVector position2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), projection3D, hitType1));
44 
45  CartesianVector position1(0.f, 0.f, 0.f);
46  const StatusCode statusCode(fitResult1.GetGlobalFitProjection(position2D, position1));
47 
48  if ((STATUS_CODE_SUCCESS != statusCode) && (STATUS_CODE_NOT_FOUND != statusCode))
49  throw StatusCodeException(statusCode);
50 
51  if (STATUS_CODE_SUCCESS == statusCode)
52  fitPositionList1.push_back(position1);
53  }
54 
55  MatchedSlidingFitMap::const_iterator fIter2 = matchedSlidingFitMap.find(hitType2);
56  if (matchedSlidingFitMap.end() != fIter2)
57  {
58  const TwoDSlidingFitResult &fitResult2 = fIter2->second;
59  const CartesianVector position2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), projection3D, hitType2));
60 
61  CartesianVector position2(0.f, 0.f, 0.f);
62  const StatusCode statusCode(fitResult2.GetGlobalFitProjection(position2D, position2));
63 
64  if ((STATUS_CODE_SUCCESS != statusCode) && (STATUS_CODE_NOT_FOUND != statusCode))
65  throw StatusCodeException(statusCode);
66 
67  if (STATUS_CODE_SUCCESS == statusCode)
68  fitPositionList2.push_back(position2);
69  }
70 
71  unsigned int nViews(1);
72  if (fitPositionList1.size() > 0)
73  ++nViews;
74  if (fitPositionList2.size() > 0)
75  ++nViews;
76 
77  if (nViews < m_minViews)
78  throw StatusCodeException(STATUS_CODE_NOT_FOUND);
79 
80  this->GetBestPosition3D(hitType1, hitType2, fitPositionList1, fitPositionList2, protoHit);
81 }
static pandora::CartesianVector ProjectPosition(const pandora::Pandora &pandora, const pandora::CartesianVector &position3D, const pandora::HitType view)
Project 3D position into a given 2D view.
intermediate_table::const_iterator const_iterator
TFile f
Definition: plotHisto.C:6
virtual void GetBestPosition3D(const pandora::HitType hitType1, const pandora::HitType hitType2, const pandora::CartesianPointVector &fitPositionList1, const pandora::CartesianPointVector &fitPositionList2, ProtoHit &protoHit) const
Get the three dimensional position using a provided two dimensional calo hit and candidate fit positi...
HitType
Definition: HitType.h:12
unsigned int m_minViews
The minimum number of views required for building hits.
void lar_content::LongitudinalTrackHitsBaseTool::GetTrackHits3D ( const pandora::CaloHitVector &  inputTwoDHits,
const MatchedSlidingFitMap matchedSlidingFitMap,
ProtoHitVector protoHitVector 
) const
protectedvirtualinherited

Calculate 3D hits from an input list of 2D hits.

Parameters
pAlgorithmthe hit creation algorithm
inputTwoDHitsthe input vector of 2D hits
matchedSlidingFitMapthe group of sliding fit results
protoHitVectorto receive the new three dimensional proto hits

Implements lar_content::TrackHitsBaseTool.

Definition at line 29 of file LongitudinalTrackHitsBaseTool.cc.

References f, lar_content::ThreeDHitCreationAlgorithm::ProtoHit::GetChi2(), lar_content::LongitudinalTrackHitsBaseTool::GetLongitudinalTrackHit3D(), lar_content::LongitudinalTrackHitsBaseTool::GetVertexAndEndPositions(), lar_content::ThreeDHitCreationAlgorithm::ProtoHit::IsPositionSet(), and lar_content::HitCreationBaseTool::m_chiSquaredCut.

31 {
32  MatchedSlidingFitMap matchedSlidingFitMap;
33  CartesianVector vtx3D(0.f, 0.f, 0.f), end3D(0.f, 0.f, 0.f);
34  this->GetVertexAndEndPositions(inputSlidingFitMap, matchedSlidingFitMap, vtx3D, end3D);
35 
36  for (const CaloHit *const pCaloHit2D : inputTwoDHits)
37  {
38  try
39  {
40  ProtoHit protoHit(pCaloHit2D);
41  this->GetLongitudinalTrackHit3D(matchedSlidingFitMap, vtx3D, end3D, protoHit);
42 
43  if (protoHit.IsPositionSet() && (protoHit.GetChi2() < m_chiSquaredCut))
44  protoHitVector.push_back(protoHit);
45  }
46  catch (StatusCodeException &)
47  {
48  }
49  }
50 }
ThreeDHitCreationAlgorithm::ProtoHit ProtoHit
std::map< pandora::HitType, TwoDSlidingFitResult > MatchedSlidingFitMap
virtual void GetLongitudinalTrackHit3D(const MatchedSlidingFitMap &matchedSlidingFitMap, const pandora::CartesianVector &vtx3D, const pandora::CartesianVector &end3D, ProtoHit &protoHit) const =0
Get the three dimensional position using a provided two dimensional calo hit and sliding linear fits ...
double m_chiSquaredCut
The chi squared cut (accept only values below the cut value)
TFile f
Definition: plotHisto.C:6
void GetVertexAndEndPositions(const MatchedSlidingFitMap &inputSlidingFitMap, MatchedSlidingFitMap &outputSlidingFitMap, pandora::CartesianVector &outputVtx3D, pandora::CartesianVector &outputEnd3D) const
Get reconstructed vertex and end positions for this 3D track.
StatusCode lar_content::LongitudinalTrackHitsBaseTool::ReadSettings ( const pandora::TiXmlHandle  xmlHandle)
protectedvirtualinherited

Reimplemented from lar_content::TrackHitsBaseTool.

Definition at line 214 of file LongitudinalTrackHitsBaseTool.cc.

References lar_content::LongitudinalTrackHitsBaseTool::m_minTrackLengthSquared, lar_content::LongitudinalTrackHitsBaseTool::m_vtxDisplacementCutSquared, and lar_content::TrackHitsBaseTool::ReadSettings().

215 {
216  float vtxDisplacementCut = std::sqrt(m_vtxDisplacementCutSquared);
217  PANDORA_RETURN_RESULT_IF_AND_IF(
218  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VertexDisplacementCut", vtxDisplacementCut));
219  m_vtxDisplacementCutSquared = vtxDisplacementCut * vtxDisplacementCut;
220 
221  float minTrackLength = std::sqrt(m_minTrackLengthSquared);
222  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinTrackLength", minTrackLength));
223  m_minTrackLengthSquared = minTrackLength * minTrackLength;
224 
225  return TrackHitsBaseTool::ReadSettings(xmlHandle);
226 }
virtual pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle)
void lar_content::TrackHitsBaseTool::Run ( ThreeDHitCreationAlgorithm *const  pAlgorithm,
const pandora::ParticleFlowObject *const  pPfo,
const pandora::CaloHitVector &  inputTwoDHits,
ProtoHitVector protoHitVector 
)
virtualinherited

Run the algorithm tool.

Parameters
pAlgorithmaddress of the calling algorithm
pPfothe address of the pfo
inputTwoDHitsthe vector of input two dimensional hits
protoHitVectorto receive the new three dimensional proto hits

Implements lar_content::HitCreationBaseTool.

Definition at line 31 of file TrackHitsBaseTool.cc.

References lar_content::TrackHitsBaseTool::BuildSlidingFitMap(), lar_content::TrackHitsBaseTool::GetTrackHits3D(), and lar_content::LArPfoHelper::IsTrack().

33 {
34  if (PandoraContentApi::GetSettings(*pAlgorithm)->ShouldDisplayAlgorithmInfo())
35  std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;
36 
37  try
38  {
39  if (!LArPfoHelper::IsTrack(pPfo))
40  return;
41 
42  MatchedSlidingFitMap matchedSlidingFitMap;
43  this->BuildSlidingFitMap(pPfo, matchedSlidingFitMap);
44 
45  if (matchedSlidingFitMap.size() < 2)
46  return;
47 
48  this->GetTrackHits3D(inputTwoDHits, matchedSlidingFitMap, protoHitVector);
49  }
50  catch (StatusCodeException &)
51  {
52  }
53 }
virtual void GetTrackHits3D(const pandora::CaloHitVector &inputTwoDHits, const MatchedSlidingFitMap &matchedSlidingFitMap, ProtoHitVector &protoHitVector) const =0
Calculate 3D hits from an input list of 2D hits.
virtual void BuildSlidingFitMap(const pandora::ParticleFlowObject *const pPfo, MatchedSlidingFitMap &matchedSlidingFitMap) const
Calculate sliding fit results for clusters from each view.
std::map< pandora::HitType, TwoDSlidingFitResult > MatchedSlidingFitMap
static bool IsTrack(const pandora::ParticleFlowObject *const pPfo)
Return track flag based on Pfo Particle ID.

Member Data Documentation

double lar_content::HitCreationBaseTool::m_chiSquaredCut
protectedinherited
unsigned int lar_content::TrackHitsBaseTool::m_minViews
protectedinherited

The minimum number of views required for building hits.

Definition at line 58 of file TrackHitsBaseTool.h.

Referenced by lar_content::TrackHitsBaseTool::ReadSettings().

double lar_content::HitCreationBaseTool::m_sigmaX2
protectedinherited

The sigmaX squared value, for calculation of chi2 deltaX term.

Definition at line 85 of file HitCreationBaseTool.h.

Referenced by lar_content::HitCreationBaseTool::ReadSettings(), and lar_content::HitCreationBaseTool::~HitCreationBaseTool().

unsigned int lar_content::TrackHitsBaseTool::m_slidingFitWindow
protectedinherited

The layer window for the sliding linear fits.

Definition at line 59 of file TrackHitsBaseTool.h.

Referenced by lar_content::TrackHitsBaseTool::BuildSlidingFitMap(), and lar_content::TrackHitsBaseTool::ReadSettings().


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