#include "PreProcessingAlgorithm.h"

Inheritance diagram for lar_content::PreProcessingAlgorithm:

Public Member Functions
	PreProcessingAlgorithm ()
	Default constructor. More...

Private Types
typedef KDTreeLinkerAlgo< const pandora::CaloHit *, 2 >	HitKDTree2D

typedef KDTreeNodeInfoT< const pandora::CaloHit *, 2 >	HitKDNode2D

typedef std::vector< HitKDNode2D >	HitKDNode2DList

Private Member Functions
pandora::StatusCode	Reset ()

pandora::StatusCode	Run ()

pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

void	ProcessCaloHits ()
	Build separate CaloHitLists for each view. More...

void	PopulateVoidCaloHitLists () noexcept
	Build empty calo hit lists. More...

void	GetFilteredCaloHitList (const pandora::CaloHitList &inputList, pandora::CaloHitList &outputList)
	Clean up the input CaloHitList. More...

void	ProcessMCParticles ()
	Build separate MCParticleLists for each view. More...

Private Attributes
pandora::CaloHitSet	m_processedHits
	The set of all previously processed calo hits. More...

float	m_mipEquivalentCut
	Minimum mip equivalent energy for calo hit. More...

float	m_minCellLengthScale
	The minimum length scale for calo hit. More...

float	m_maxCellLengthScale
	The maximum length scale for calo hit. More...

float	m_searchRegion1D
	Search region, applied to each dimension, for look-up from kd-trees. More...

unsigned int	m_maxEventHits
	The maximum number of hits in an event to proceed with the reconstruction. More...

bool	m_onlyAvailableCaloHits
	Whether to only include available calo hits. More...

std::string	m_inputCaloHitListName
	The input calo hit list name. More...

std::string	m_outputCaloHitListNameU
	The output calo hit list name for TPC_VIEW_U hits. More...

std::string	m_outputCaloHitListNameV
	The output calo hit list name for TPC_VIEW_V hits. More...

std::string	m_outputCaloHitListNameW
	The output calo hit list name for TPC_VIEW_W hits. More...

std::string	m_filteredCaloHitListName
	The output calo hit list name for all U, V and W hits. More...

std::string	m_currentCaloHitListReplacement
	The name of the calo hit list to replace the current list (optional) More...

Detailed Description

PreProcessingAlgorithm class.

Definition at line 26 of file PreProcessingAlgorithm.h.

Member Typedef Documentation

typedef KDTreeNodeInfoT<const pandora::CaloHit *, 2> lar_content::PreProcessingAlgorithm::HitKDNode2D

private

Definition at line 36 of file PreProcessingAlgorithm.h.

typedef std::vector<HitKDNode2D> lar_content::PreProcessingAlgorithm::HitKDNode2DList

private

Definition at line 37 of file PreProcessingAlgorithm.h.

typedef KDTreeLinkerAlgo<const pandora::CaloHit *, 2> lar_content::PreProcessingAlgorithm::HitKDTree2D

private

Definition at line 35 of file PreProcessingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::PreProcessingAlgorithm::PreProcessingAlgorithm ( )

Default constructor.

Definition at line 22 of file PreProcessingAlgorithm.cc.

                                                :
     m_mipEquivalentCut(std::numeric_limits<float>::epsilon()),
     m_minCellLengthScale(std::numeric_limits<float>::epsilon()),
     m_maxCellLengthScale(3.f),
     m_searchRegion1D(0.1f),
     m_maxEventHits(std::numeric_limits<unsigned int>::max()),
     m_onlyAvailableCaloHits(true),
     m_inputCaloHitListName("Input")
 {
 }

Member Function Documentation

void lar_content::PreProcessingAlgorithm::GetFilteredCaloHitList	(	const pandora::CaloHitList &	inputList,
		pandora::CaloHitList &	outputList
	)

private

Clean up the input CaloHitList.

Parameters

inputList	the input CaloHitList
outputList	the output CaloHitList

Definition at line 189 of file PreProcessingAlgorithm.cc.

References lar_content::KDTreeLinkerAlgo< DATA, DIM >::build(), lar_content::build_2d_kd_search_region(), lar_content::fill_and_bound_2d_kd_tree(), m_searchRegion1D, and lar_content::KDTreeLinkerAlgo< DATA, DIM >::search().

Referenced by ProcessCaloHits().

 {
     HitKDTree2D kdTree;
     HitKDNode2DList hitKDNode2DList;
 
     KDTreeBox hitsBoundingRegion2D = fill_and_bound_2d_kd_tree(inputList, hitKDNode2DList);
     kdTree.build(hitKDNode2DList, hitsBoundingRegion2D);
 
     // Remove hits that are in the same physical location!
     for (const CaloHit *const pCaloHit1 : inputList)
     {
         bool isUnique(true);
         KDTreeBox searchRegionHits(build_2d_kd_search_region(pCaloHit1, m_searchRegion1D, m_searchRegion1D));
 
         HitKDNode2DList found;
         kdTree.search(searchRegionHits, found);
 
         for (const auto &hit : found)
         {
             const CaloHit *const pCaloHit2(hit.data);
 
             if (pCaloHit1 == pCaloHit2)
                 continue;
 
             const float displacementSquared((pCaloHit2->GetPositionVector() - pCaloHit1->GetPositionVector()).GetMagnitudeSquared());
 
             if (displacementSquared < std::numeric_limits<float>::epsilon())
             {
                 const float deltaMip(pCaloHit2->GetMipEquivalentEnergy() > pCaloHit1->GetMipEquivalentEnergy());
 
                 if ((deltaMip > std::numeric_limits<float>::epsilon()) ||
                     ((std::fabs(deltaMip) < std::numeric_limits<float>::epsilon()) &&
                         (outputList.end() != std::find(outputList.begin(), outputList.end(), pCaloHit2))))
                 {
                     isUnique = false;
                     break;
                 }
             }
         }
 
         if (isUnique)
         {
             outputList.push_back(pCaloHit1);
         }
         else
         {
             if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
                 std::cout << "PreProcessingAlgorithm: found two hits in same location, will remove lowest pulse height" << std::endl;
         }
     }
 }

void lar_content::PreProcessingAlgorithm::PopulateVoidCaloHitLists ( )

privatenoexcept

Build empty calo hit lists.

Definition at line 163 of file PreProcessingAlgorithm.cc.

References m_filteredCaloHitListName, m_outputCaloHitListNameU, m_outputCaloHitListNameV, and m_outputCaloHitListNameW.

Referenced by Run().

 {
     CaloHitList emptyList;
 
     try
     {
         if (!m_filteredCaloHitListName.empty())
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, emptyList, m_filteredCaloHitListName));
 
         if (!m_outputCaloHitListNameU.empty())
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, emptyList, m_outputCaloHitListNameU));
 
         if (!m_outputCaloHitListNameV.empty())
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, emptyList, m_outputCaloHitListNameV));
 
         if (!m_outputCaloHitListNameW.empty())
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, emptyList, m_outputCaloHitListNameW));
     }
     catch (...)
     {
         std::cout << "PreProcessingAlgorithm: Unable to create void calo hit lists" << std::endl;
     }
 }

void lar_content::PreProcessingAlgorithm::ProcessCaloHits ( )

private

Build separate CaloHitLists for each view.

Definition at line 79 of file PreProcessingAlgorithm.cc.

References GetFilteredCaloHitList(), m_filteredCaloHitListName, m_inputCaloHitListName, m_maxCellLengthScale, m_maxEventHits, m_minCellLengthScale, m_mipEquivalentCut, m_onlyAvailableCaloHits, m_outputCaloHitListNameU, m_outputCaloHitListNameV, m_outputCaloHitListNameW, and m_processedHits.

Referenced by Run().

 {
     const CaloHitList *pCaloHitList(nullptr);
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_inputCaloHitListName, pCaloHitList));
 
     if (pCaloHitList->empty())
         return;
 
     if (pCaloHitList->size() > m_maxEventHits)
         throw StatusCodeException(STATUS_CODE_OUT_OF_RANGE);
 
     CaloHitList selectedCaloHitListU, selectedCaloHitListV, selectedCaloHitListW;
 
     for (const CaloHit *const pCaloHit : *pCaloHitList)
     {
         if (m_processedHits.count(pCaloHit))
             continue;
 
         (void)m_processedHits.insert(pCaloHit);
 
         if (m_onlyAvailableCaloHits && !PandoraContentApi::IsAvailable(*this, pCaloHit))
             continue;
 
         if (pCaloHit->GetMipEquivalentEnergy() < m_mipEquivalentCut)
             continue;
 
         if (pCaloHit->GetInputEnergy() < std::numeric_limits<float>::epsilon())
         {
             if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
                 std::cout << "PreProcessingAlgorithm: found a hit with zero energy, will remove it" << std::endl;
 
             continue;
         }
 
         if ((pCaloHit->GetCellLengthScale() < m_minCellLengthScale) || (pCaloHit->GetCellLengthScale() > m_maxCellLengthScale))
         {
             if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
             {
                 std::cout << "PreProcessingAlgorithm: found a hit with extent " << pCaloHit->GetCellLengthScale() << ", require ("
                           << m_minCellLengthScale << " - " << m_maxCellLengthScale << "), will remove it" << std::endl;
             }
 
             continue;
         }
 
         if (TPC_VIEW_U == pCaloHit->GetHitType())
         {
             selectedCaloHitListU.push_back(pCaloHit);
         }
         else if (TPC_VIEW_V == pCaloHit->GetHitType())
         {
             selectedCaloHitListV.push_back(pCaloHit);
         }
         else if (TPC_VIEW_W == pCaloHit->GetHitType())
         {
             selectedCaloHitListW.push_back(pCaloHit);
         }
     }
 
     CaloHitList filteredCaloHitListU, filteredCaloHitListV, filteredCaloHitListW;
     this->GetFilteredCaloHitList(selectedCaloHitListU, filteredCaloHitListU);
     this->GetFilteredCaloHitList(selectedCaloHitListV, filteredCaloHitListV);
     this->GetFilteredCaloHitList(selectedCaloHitListW, filteredCaloHitListW);
 
     CaloHitList filteredInputList;
     filteredInputList.insert(filteredInputList.end(), filteredCaloHitListU.begin(), filteredCaloHitListU.end());
     filteredInputList.insert(filteredInputList.end(), filteredCaloHitListV.begin(), filteredCaloHitListV.end());
     filteredInputList.insert(filteredInputList.end(), filteredCaloHitListW.begin(), filteredCaloHitListW.end());
 
     if (!filteredInputList.empty() && !m_filteredCaloHitListName.empty())
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, filteredInputList, m_filteredCaloHitListName));
 
     if (!filteredCaloHitListU.empty() && !m_outputCaloHitListNameU.empty())
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, filteredCaloHitListU, m_outputCaloHitListNameU));
 
     if (!filteredCaloHitListV.empty() && !m_outputCaloHitListNameV.empty())
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, filteredCaloHitListV, m_outputCaloHitListNameV));
 
     if (!filteredCaloHitListW.empty() && !m_outputCaloHitListNameW.empty())
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, filteredCaloHitListW, m_outputCaloHitListNameW));
 }

void lar_content::PreProcessingAlgorithm::ProcessMCParticles ( )

private

Build separate MCParticleLists for each view.

StatusCode lar_content::PreProcessingAlgorithm::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

private

Definition at line 243 of file PreProcessingAlgorithm.cc.

References m_currentCaloHitListReplacement, m_filteredCaloHitListName, m_inputCaloHitListName, m_maxCellLengthScale, m_maxEventHits, m_minCellLengthScale, m_mipEquivalentCut, m_onlyAvailableCaloHits, m_outputCaloHitListNameU, m_outputCaloHitListNameV, m_outputCaloHitListNameW, and m_searchRegion1D.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MipEquivalentCut", m_mipEquivalentCut));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinCellLengthScale", m_minCellLengthScale));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxCellLengthScale", m_maxCellLengthScale));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SearchRegion1D", m_searchRegion1D));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxEventHits", m_maxEventHits));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "OnlyAvailableCaloHits", m_onlyAvailableCaloHits));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "InputCaloHitListName", m_inputCaloHitListName));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "OutputCaloHitListNameU", m_outputCaloHitListNameU));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "OutputCaloHitListNameV", m_outputCaloHitListNameV));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "OutputCaloHitListNameW", m_outputCaloHitListNameW));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "FilteredCaloHitListName", m_filteredCaloHitListName));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "CurrentCaloHitListReplacement", m_currentCaloHitListReplacement));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::PreProcessingAlgorithm::Reset ( )

private

Definition at line 35 of file PreProcessingAlgorithm.cc.

References m_processedHits.

 {
     m_processedHits.clear();
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::PreProcessingAlgorithm::Run ( )

private

Definition at line 43 of file PreProcessingAlgorithm.cc.

References m_currentCaloHitListReplacement, PopulateVoidCaloHitLists(), and ProcessCaloHits().

 {
     if (!this->GetPandora().GetSettings()->SingleHitTypeClusteringMode())
     {
         std::cout << "PreProcessingAlgorithm: expect Pandora to be configured in SingleHitTypeClusteringMode." << std::endl;
         return STATUS_CODE_FAILURE;
     }
 
     try
     {
         this->ProcessCaloHits();
     }
     catch (const StatusCodeException &statusCodeException)
     {
         if (STATUS_CODE_OUT_OF_RANGE == statusCodeException.GetStatusCode())
         {
             std::cout << "PreProcessingAlgorithm: Excessive number of hits in event, skipping the reconstruction" << std::endl;
             this->PopulateVoidCaloHitLists();
         }
     }
 
     if (!m_currentCaloHitListReplacement.empty())
     {
         if (STATUS_CODE_SUCCESS != PandoraContentApi::ReplaceCurrentList<CaloHit>(*this, m_currentCaloHitListReplacement))
         {
             if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
                 std::cout << "PreProcessingAlgorithm: could not replace current calo hit list with list named: " << m_currentCaloHitListReplacement
                           << std::endl;
         }
     }
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

std::string lar_content::PreProcessingAlgorithm::m_currentCaloHitListReplacement

private

The name of the calo hit list to replace the current list (optional)

Definition at line 80 of file PreProcessingAlgorithm.h.

Referenced by ReadSettings(), and Run().

std::string lar_content::PreProcessingAlgorithm::m_filteredCaloHitListName

private

The output calo hit list name for all U, V and W hits.

Definition at line 79 of file PreProcessingAlgorithm.h.

Referenced by PopulateVoidCaloHitLists(), ProcessCaloHits(), and ReadSettings().

std::string lar_content::PreProcessingAlgorithm::m_inputCaloHitListName

private

The input calo hit list name.

Definition at line 75 of file PreProcessingAlgorithm.h.

Referenced by ProcessCaloHits(), and ReadSettings().

float lar_content::PreProcessingAlgorithm::m_maxCellLengthScale

private

The maximum length scale for calo hit.

Definition at line 70 of file PreProcessingAlgorithm.h.

Referenced by ProcessCaloHits(), and ReadSettings().

unsigned int lar_content::PreProcessingAlgorithm::m_maxEventHits

private

The maximum number of hits in an event to proceed with the reconstruction.

Definition at line 72 of file PreProcessingAlgorithm.h.

Referenced by ProcessCaloHits(), and ReadSettings().

float lar_content::PreProcessingAlgorithm::m_minCellLengthScale

private

The minimum length scale for calo hit.

Definition at line 69 of file PreProcessingAlgorithm.h.

Referenced by ProcessCaloHits(), and ReadSettings().

float lar_content::PreProcessingAlgorithm::m_mipEquivalentCut

private

Minimum mip equivalent energy for calo hit.

Definition at line 68 of file PreProcessingAlgorithm.h.

Referenced by ProcessCaloHits(), and ReadSettings().

bool lar_content::PreProcessingAlgorithm::m_onlyAvailableCaloHits

private

Whether to only include available calo hits.

Definition at line 74 of file PreProcessingAlgorithm.h.

Referenced by ProcessCaloHits(), and ReadSettings().

std::string lar_content::PreProcessingAlgorithm::m_outputCaloHitListNameU

private

The output calo hit list name for TPC_VIEW_U hits.

Definition at line 76 of file PreProcessingAlgorithm.h.

Referenced by PopulateVoidCaloHitLists(), ProcessCaloHits(), and ReadSettings().

std::string lar_content::PreProcessingAlgorithm::m_outputCaloHitListNameV

private

The output calo hit list name for TPC_VIEW_V hits.

Definition at line 77 of file PreProcessingAlgorithm.h.

Referenced by PopulateVoidCaloHitLists(), ProcessCaloHits(), and ReadSettings().

std::string lar_content::PreProcessingAlgorithm::m_outputCaloHitListNameW

private

The output calo hit list name for TPC_VIEW_W hits.

Definition at line 78 of file PreProcessingAlgorithm.h.

Referenced by PopulateVoidCaloHitLists(), ProcessCaloHits(), and ReadSettings().

pandora::CaloHitSet lar_content::PreProcessingAlgorithm::m_processedHits

private

The set of all previously processed calo hits.

Definition at line 66 of file PreProcessingAlgorithm.h.

Referenced by ProcessCaloHits(), and Reset().

float lar_content::PreProcessingAlgorithm::m_searchRegion1D

private

Search region, applied to each dimension, for look-up from kd-trees.

Definition at line 71 of file PreProcessingAlgorithm.h.

Referenced by GetFilteredCaloHitList(), and ReadSettings().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArControlFlow/PreProcessingAlgorithm.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArControlFlow/PreProcessingAlgorithm.cc

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation