DeepLearningTrackShowerIdAlgorithm class. More...

#include "DlVertexingBaseAlgorithm.h"

Inheritance diagram for lar_dl_content::DlVertexingBaseAlgorithm:

Public Types
typedef std::map< std::pair< int, int >, std::vector< const pandora::CaloHit * > >	PixelToCaloHitsMap

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

	~DlVertexingBaseAlgorithm ()

Protected Types
typedef std::pair< int, int >	Pixel

typedef std::vector< Pixel >	PixelVector

Protected Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

void	GetHitRegion (const pandora::CaloHitList &caloHitList, float &xMin, float &xMax, float &zMin, float &zMax) const

void	GetCanvasParameters (const LArDLHelper::TorchOutput &networkOutput, const PixelVector &pixelVector, int &columnOffset, int &rowOffset, int &width, int &height) const
	Determines the parameters of the canvas for extracting the vertex location. The network predicts the distance that each pixel associated with a hit is located from the vertex, but says nothing about the direction. As a result, the ring describing the potential vertices associated with that hit can extend beyond the original canvas size. This function returns the size of the required canvas and the offset for the bottom left corner. More...

Protected Attributes
bool	m_trainingMode
	Training mode. More...

std::string	m_trainingOutputFile
	Output file name for training examples. More...

std::string	m_inputVertexListName
	Input vertex list name if 2nd pass. More...

std::string	m_outputVertexListName
	Output vertex list name. More...

pandora::StringVector	m_caloHitListNames
	Names of input calo hit lists. More...

LArDLHelper::TorchModel	m_modelU
	The model for the U view. More...

LArDLHelper::TorchModel	m_modelV
	The model for the V view. More...

LArDLHelper::TorchModel	m_modelW
	The model for the W view. More...

int	m_pass
	The pass of the train/infer step. More...

int	m_nClasses
	The number of distance classes. More...

int	m_height
	The height of the images. More...

int	m_width
	The width of the images. More...

float	m_driftStep
	The size of a pixel in the drift direction in cm (most relevant in pass 2) More...

std::vector< double >	m_thresholds
	Distance class thresholds. More...

std::string	m_volumeType
	The name of the fiducial volume type for the monitoring output. More...

Detailed Description

DeepLearningTrackShowerIdAlgorithm class.

Definition at line 28 of file DlVertexingBaseAlgorithm.h.

Member Typedef Documentation

typedef std::pair<int, int> lar_dl_content::DlVertexingBaseAlgorithm::Pixel

protected

Definition at line 41 of file DlVertexingBaseAlgorithm.h.

typedef std::map<std::pair<int, int>, std::vector<const pandora::CaloHit *> > lar_dl_content::DlVertexingBaseAlgorithm::PixelToCaloHitsMap

Definition at line 31 of file DlVertexingBaseAlgorithm.h.

typedef std::vector<Pixel> lar_dl_content::DlVertexingBaseAlgorithm::PixelVector

protected

Definition at line 42 of file DlVertexingBaseAlgorithm.h.

Constructor & Destructor Documentation

lar_dl_content::DlVertexingBaseAlgorithm::DlVertexingBaseAlgorithm ( )

Default constructor.

Definition at line 30 of file DlVertexingBaseAlgorithm.cc.

References m_driftStep, m_height, m_nClasses, m_pass, m_trainingOutputFile, m_volumeType, and m_width.

                                                    :
     m_trainingMode{false},
     m_trainingOutputFile{""},
     m_pass{1},
     m_nClasses{0},
     m_height{256},
     m_width{256},
     m_driftStep{0.5f},
     m_volumeType{"dune_fd_hd"}
 {
 }

lar_dl_content::DlVertexingBaseAlgorithm::~DlVertexingBaseAlgorithm ( )

Definition at line 44 of file DlVertexingBaseAlgorithm.cc.

45 {

46 }

Member Function Documentation

void lar_dl_content::DlVertexingBaseAlgorithm::GetCanvasParameters	(	const LArDLHelper::TorchOutput &	networkOutput,
		const PixelVector &	pixelVector,
		int &	columnOffset,
		int &	rowOffset,
		int &	width,
		int &	height
	)		const

protected

Determines the parameters of the canvas for extracting the vertex location. The network predicts the distance that each pixel associated with a hit is located from the vertex, but says nothing about the direction. As a result, the ring describing the potential vertices associated with that hit can extend beyond the original canvas size. This function returns the size of the required canvas and the offset for the bottom left corner.

Parameters

networkOutput	The TorchOutput object populated by the network inference step
pixelVector	The vector of populated pixels
columnOffset	The output column offset for the canvas
rowOffset	The output row offset for the canvas
width	The output width for the canvas
height	The output height for the canvas

Definition at line 165 of file DlVertexingBaseAlgorithm.cc.

References col, m_height, m_thresholds, and m_width.

Referenced by lar_dl_content::DlVertexingAlgorithm::Infer(), and lar_dl_content::DlSecondaryVertexingAlgorithm::Infer().

 {
     const double scaleFactor{std::sqrt(m_height * m_height + m_width * m_width)};
     // output is a 1 x num_classes x height x width tensor
     // we want the maximum value in the num_classes dimension (1) for every pixel
     auto classes{torch::argmax(networkOutput, 1)};
     // the argmax result is a 1 x height x width tensor where each element is a class id
     auto classesAccessor{classes.accessor<int64_t, 3>()};
     int colOffsetMin{0}, colOffsetMax{0}, rowOffsetMin{0}, rowOffsetMax{0};
     for (const auto &[row, col] : pixelVector)
     {
         const auto cls{classesAccessor[0][row][col]};
         const double threshold{m_thresholds[cls]};
         if (threshold > 0. && threshold < 1.)
         {
             const int distance = static_cast<int>(std::round(std::ceil(scaleFactor * threshold)));
             if ((row - distance) < rowOffsetMin)
                 rowOffsetMin = row - distance;
             if ((row + distance) > rowOffsetMax)
                 rowOffsetMax = row + distance;
             if ((col - distance) < colOffsetMin)
                 colOffsetMin = col - distance;
             if ((col + distance) > colOffsetMax)
                 colOffsetMax = col + distance;
         }
     }
     colOffset = colOffsetMin < 0 ? -colOffsetMin : 0;
     rowOffset = rowOffsetMin < 0 ? -rowOffsetMin : 0;
     width = std::max(colOffsetMax + colOffset + 1, m_width);
     height = std::max(rowOffsetMax + rowOffset + 1, m_height);
 }

void lar_dl_content::DlVertexingBaseAlgorithm::GetHitRegion	(	const pandora::CaloHitList &	caloHitList,
		float &	xMin,
		float &	xMax,
		float &	zMin,
		float &	zMax
	)		const

protected

Definition at line 50 of file DlVertexingBaseAlgorithm.cc.

References util::begin(), m_caloHitListNames, m_driftStep, m_height, m_inputVertexListName, m_pass, m_width, x, and z.

Referenced by lar_dl_content::DlVertexingAlgorithm::Infer(), lar_dl_content::DlSecondaryVertexingAlgorithm::Infer(), lar_dl_content::DlVertexingAlgorithm::PrepareTrainingSample(), and lar_dl_content::DlSecondaryVertexingAlgorithm::PrepareTrainingSample().

 {
     xMin = std::numeric_limits<float>::max();
     xMax = -std::numeric_limits<float>::max();
     zMin = std::numeric_limits<float>::max();
     zMax = -std::numeric_limits<float>::max();
     // Find the range of x and z values in the view
     for (const CaloHit *pCaloHit : caloHitList)
     {
         const float x{pCaloHit->GetPositionVector().GetX()};
         const float z{pCaloHit->GetPositionVector().GetZ()};
         xMin = std::min(x, xMin);
         xMax = std::max(x, xMax);
         zMin = std::min(z, zMin);
         zMax = std::max(z, zMax);
     }
 
     if (caloHitList.empty())
         throw StatusCodeException(STATUS_CODE_NOT_FOUND);
 
     const HitType view{caloHitList.front()->GetHitType()};
     const bool isU{view == TPC_VIEW_U}, isV{view == TPC_VIEW_V}, isW{view == TPC_VIEW_W};
     if (!(isU || isV || isW))
         throw StatusCodeException(STATUS_CODE_NOT_ALLOWED);
 
     // ATTN If wire w pitches vary between TPCs, exception will be raised in initialisation of lar pseudolayer plugin
     const LArTPC *const pTPC(this->GetPandora().GetGeometry()->GetLArTPCMap().begin()->second);
     const float pitch(view == TPC_VIEW_U ? pTPC->GetWirePitchU() : view == TPC_VIEW_V ? pTPC->GetWirePitchV() : pTPC->GetWirePitchW());
 
     if (m_pass > 1)
     {
         const VertexList *pVertexList(nullptr);
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_inputVertexListName, pVertexList));
         if (pVertexList->empty())
             throw StatusCodeException(STATUS_CODE_NOT_FOUND);
         const CartesianVector &vertex{pVertexList->front()->GetPosition()};
 
         // Get hit distribution left/right asymmetry
         int nHitsLeft{0}, nHitsRight{0};
         const double xVtx{vertex.GetX()};
         for (const std::string &listname : m_caloHitListNames)
         {
             const CaloHitList *pCaloHitList(nullptr);
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, listname, pCaloHitList));
             if (pCaloHitList->empty())
                 continue;
             for (const CaloHit *const pCaloHit : *pCaloHitList)
             {
                 const CartesianVector &pos{pCaloHit->GetPositionVector()};
                 if (pos.GetX() <= xVtx)
                     ++nHitsLeft;
                 else
                     ++nHitsRight;
             }
         }
         const int nHitsTotal{nHitsLeft + nHitsRight};
         if (nHitsTotal == 0)
             throw StatusCodeException(STATUS_CODE_NOT_FOUND);
         const float xAsymmetry{nHitsLeft / static_cast<float>(nHitsTotal)};
 
         // Vertices
         const LArTransformationPlugin *transform{this->GetPandora().GetPlugins()->GetLArTransformationPlugin()};
         double zVtx{0.};
         if (isW)
             zVtx += transform->YZtoW(vertex.GetY(), vertex.GetZ());
         else if (isV)
             zVtx += transform->YZtoV(vertex.GetY(), vertex.GetZ());
         else
             zVtx = transform->YZtoU(vertex.GetY(), vertex.GetZ());
 
         // Get hit distribution upstream/downstream asymmetry
         int nHitsUpstream{0}, nHitsDownstream{0};
         for (const CaloHit *const pCaloHit : caloHitList)
         {
             const CartesianVector &pos{pCaloHit->GetPositionVector()};
             if (pos.GetZ() <= zVtx)
                 ++nHitsUpstream;
             else
                 ++nHitsDownstream;
         }
         const int nHitsViewTotal{nHitsUpstream + nHitsDownstream};
         if (nHitsViewTotal == 0)
             throw StatusCodeException(STATUS_CODE_NOT_FOUND);
         const float zAsymmetry{nHitsUpstream / static_cast<float>(nHitsViewTotal)};
 
         const float xSpan{m_driftStep * (m_width - 1)};
         xMin = xVtx - xAsymmetry * xSpan;
         xMax = xMin + (m_driftStep * (m_width - 1));
         const float zSpan{pitch * (m_height - 1)};
         zMin = zVtx - zAsymmetry * zSpan;
         zMax = zMin + zSpan;
     }
 
     // Avoid unreasonable rescaling of very small hit regions, pixels are assumed to be 0.5cm in x and wire pitch in z
     // ATTN: Rescaling is to a size 1 pixel smaller than the intended image to ensure all hits fit within an imaged binned
     // to be one pixel wider than this
     const float xRange{xMax - xMin}, zRange{zMax - zMin};
     const float minXSpan{m_driftStep * (m_width - 1)};
     if (xRange < minXSpan)
     {
         const float padding{0.5f * (minXSpan - xRange)};
         xMin -= padding;
         xMax += padding;
     }
     const float minZSpan{pitch * (m_height - 1)};
     if (zRange < minZSpan)
     {
         const float padding{0.5f * (minZSpan - zRange)};
         zMin -= padding;
         zMax += padding;
     }
 }

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

protected

Definition at line 200 of file DlVertexingBaseAlgorithm.cc.

References lar_dl_content::LArDLHelper::LoadModel(), m_caloHitListNames, m_driftStep, m_height, m_inputVertexListName, m_modelU, m_modelV, m_modelW, m_nClasses, m_outputVertexListName, m_pass, m_thresholds, m_trainingMode, m_trainingOutputFile, m_volumeType, and m_width.

Referenced by lar_dl_content::DlVertexingAlgorithm::ReadSettings(), and lar_dl_content::DlSecondaryVertexingAlgorithm::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "TrainingMode", m_trainingMode));
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "Pass", m_pass));
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ImageHeight", m_height));
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ImageWidth", m_width));
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "DriftStep", m_driftStep));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "DistanceThresholds", m_thresholds));
     m_nClasses = m_thresholds.size() - 1;
     if (m_pass > 1)
     {
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputVertexListName", m_inputVertexListName));
     }
 
     if (m_trainingMode)
     {
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "TrainingOutputFileName", m_trainingOutputFile));
     }
     else
     {
         std::string modelName;
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "ModelFileNameU", modelName));
         modelName = LArFileHelper::FindFileInPath(modelName, "FW_SEARCH_PATH");
         LArDLHelper::LoadModel(modelName, m_modelU);
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "ModelFileNameV", modelName));
         modelName = LArFileHelper::FindFileInPath(modelName, "FW_SEARCH_PATH");
         LArDLHelper::LoadModel(modelName, m_modelV);
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "ModelFileNameW", modelName));
         modelName = LArFileHelper::FindFileInPath(modelName, "FW_SEARCH_PATH");
         LArDLHelper::LoadModel(modelName, m_modelW);
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "OutputVertexListName", m_outputVertexListName));
     }
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "CaloHitListNames", m_caloHitListNames));
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VolumeType", m_volumeType));
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

pandora::StringVector lar_dl_content::DlVertexingBaseAlgorithm::m_caloHitListNames

protected

Names of input calo hit lists.

Definition at line 79 of file DlVertexingBaseAlgorithm.h.

Referenced by GetHitRegion(), lar_dl_content::DlVertexingAlgorithm::Infer(), lar_dl_content::DlSecondaryVertexingAlgorithm::Infer(), lar_dl_content::DlVertexingAlgorithm::PrepareTrainingSample(), lar_dl_content::DlSecondaryVertexingAlgorithm::PrepareTrainingSample(), and ReadSettings().

float lar_dl_content::DlVertexingBaseAlgorithm::m_driftStep

protected

The size of a pixel in the drift direction in cm (most relevant in pass 2)

Definition at line 87 of file DlVertexingBaseAlgorithm.h.

Referenced by DlVertexingBaseAlgorithm(), GetHitRegion(), lar_dl_content::DlVertexingAlgorithm::MakeNetworkInputFromHits(), lar_dl_content::DlVertexingAlgorithm::MakeWirePlaneCoordinatesFromCanvas(), and ReadSettings().

int lar_dl_content::DlVertexingBaseAlgorithm::m_height

protected

The height of the images.

Definition at line 85 of file DlVertexingBaseAlgorithm.h.

Referenced by DlVertexingBaseAlgorithm(), GetCanvasParameters(), GetHitRegion(), lar_dl_content::DlSecondaryVertexingAlgorithm::GetVerticesFromCanvas(), lar_dl_content::DlVertexingAlgorithm::Infer(), lar_dl_content::DlSecondaryVertexingAlgorithm::Infer(), lar_dl_content::DlVertexingAlgorithm::MakeNetworkInputFromHits(), lar_dl_content::DlSecondaryVertexingAlgorithm::MakeNetworkInputFromHits(), lar_dl_content::DlVertexingAlgorithm::MakeWirePlaneCoordinatesFromCanvas(), and ReadSettings().

std::string lar_dl_content::DlVertexingBaseAlgorithm::m_inputVertexListName

protected

Input vertex list name if 2nd pass.

Definition at line 77 of file DlVertexingBaseAlgorithm.h.

Referenced by GetHitRegion(), lar_dl_content::DlVertexingAlgorithm::Infer(), and ReadSettings().

LArDLHelper::TorchModel lar_dl_content::DlVertexingBaseAlgorithm::m_modelU

protected

The model for the U view.

Definition at line 80 of file DlVertexingBaseAlgorithm.h.

Referenced by lar_dl_content::DlVertexingAlgorithm::Infer(), lar_dl_content::DlSecondaryVertexingAlgorithm::Infer(), and ReadSettings().

LArDLHelper::TorchModel lar_dl_content::DlVertexingBaseAlgorithm::m_modelV

protected

The model for the V view.

Definition at line 81 of file DlVertexingBaseAlgorithm.h.

Referenced by lar_dl_content::DlVertexingAlgorithm::Infer(), lar_dl_content::DlSecondaryVertexingAlgorithm::Infer(), and ReadSettings().

LArDLHelper::TorchModel lar_dl_content::DlVertexingBaseAlgorithm::m_modelW

protected

The model for the W view.

Definition at line 82 of file DlVertexingBaseAlgorithm.h.

Referenced by lar_dl_content::DlVertexingAlgorithm::Infer(), lar_dl_content::DlSecondaryVertexingAlgorithm::Infer(), and ReadSettings().

int lar_dl_content::DlVertexingBaseAlgorithm::m_nClasses

protected

The number of distance classes.

Definition at line 84 of file DlVertexingBaseAlgorithm.h.

Referenced by DlVertexingBaseAlgorithm(), lar_dl_content::DlVertexingAlgorithm::Infer(), lar_dl_content::DlSecondaryVertexingAlgorithm::Infer(), and ReadSettings().

std::string lar_dl_content::DlVertexingBaseAlgorithm::m_outputVertexListName

protected

Output vertex list name.

Definition at line 78 of file DlVertexingBaseAlgorithm.h.

Referenced by lar_dl_content::DlVertexingAlgorithm::MakeCandidateVertexList(), lar_dl_content::DlSecondaryVertexingAlgorithm::MakeCandidateVertexList(), and ReadSettings().

int lar_dl_content::DlVertexingBaseAlgorithm::m_pass

protected

The pass of the train/infer step.

Definition at line 83 of file DlVertexingBaseAlgorithm.h.

Referenced by DlVertexingBaseAlgorithm(), GetHitRegion(), lar_dl_content::DlVertexingAlgorithm::Infer(), lar_dl_content::DlVertexingAlgorithm::MakeCandidateVertexList(), lar_dl_content::DlVertexingAlgorithm::MakeNetworkInputFromHits(), lar_dl_content::DlSecondaryVertexingAlgorithm::MakeNetworkInputFromHits(), lar_dl_content::DlVertexingAlgorithm::PrepareTrainingSample(), and ReadSettings().

std::vector<double> lar_dl_content::DlVertexingBaseAlgorithm::m_thresholds

protected

Distance class thresholds.

Definition at line 88 of file DlVertexingBaseAlgorithm.h.

Referenced by GetCanvasParameters(), lar_dl_content::DlVertexingAlgorithm::Infer(), lar_dl_content::DlSecondaryVertexingAlgorithm::Infer(), and ReadSettings().

bool lar_dl_content::DlVertexingBaseAlgorithm::m_trainingMode

protected

Training mode.

Definition at line 75 of file DlVertexingBaseAlgorithm.h.

Referenced by lar_dl_content::DlVertexingAlgorithm::ReadSettings(), ReadSettings(), lar_dl_content::DlSecondaryVertexingAlgorithm::ReadSettings(), lar_dl_content::DlVertexingAlgorithm::Run(), and lar_dl_content::DlSecondaryVertexingAlgorithm::Run().

std::string lar_dl_content::DlVertexingBaseAlgorithm::m_trainingOutputFile

protected

Output file name for training examples.

Definition at line 76 of file DlVertexingBaseAlgorithm.h.

Referenced by DlVertexingBaseAlgorithm(), lar_dl_content::DlVertexingAlgorithm::PrepareTrainingSample(), lar_dl_content::DlSecondaryVertexingAlgorithm::PrepareTrainingSample(), and ReadSettings().

std::string lar_dl_content::DlVertexingBaseAlgorithm::m_volumeType

protected

The name of the fiducial volume type for the monitoring output.

Definition at line 89 of file DlVertexingBaseAlgorithm.h.

Referenced by DlVertexingBaseAlgorithm(), lar_dl_content::DlVertexingAlgorithm::MakeCandidateVertexList(), lar_dl_content::DlSecondaryVertexingAlgorithm::PrepareTrainingSample(), and ReadSettings().

int lar_dl_content::DlVertexingBaseAlgorithm::m_width

protected

The width of the images.

Definition at line 86 of file DlVertexingBaseAlgorithm.h.

Referenced by DlVertexingBaseAlgorithm(), GetCanvasParameters(), GetHitRegion(), lar_dl_content::DlSecondaryVertexingAlgorithm::GetVerticesFromCanvas(), lar_dl_content::DlVertexingAlgorithm::Infer(), lar_dl_content::DlSecondaryVertexingAlgorithm::Infer(), lar_dl_content::DlVertexingAlgorithm::MakeNetworkInputFromHits(), lar_dl_content::DlSecondaryVertexingAlgorithm::MakeNetworkInputFromHits(), lar_dl_content::DlVertexingAlgorithm::MakeWirePlaneCoordinatesFromCanvas(), and ReadSettings().

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

larpandoracontent/v04_14_00/source/larpandoradlcontent/LArVertex/DlVertexingBaseAlgorithm.h
larpandoracontent/v04_14_00/source/larpandoradlcontent/LArVertex/DlVertexingBaseAlgorithm.cc

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation