#include <PointIdAlg.h>

Inheritance diagram for nnet::PointIdAlg:

Classes
struct	Config

Public Member Functions
	PointIdAlg (const fhicl::ParameterSet &pset)

	PointIdAlg (const Config &config)

	~PointIdAlg () override

std::vector< std::string > const &	outputLabels () const
	network output labels More...

float	predictIdValue (unsigned int wire, float drift, size_t outIdx=0) const
	calculate single-value prediction (2-class probability) for [wire, drift] point More...

std::vector< float >	predictIdVector (unsigned int wire, float drift) const
	calculate multi-class probabilities for [wire, drift] point More...

std::vector< std::vector< float > >	predictIdVectors (std::vector< std::pair< unsigned int, float >> points) const

std::vector< std::vector< float > > const &	patchData2D () const

std::vector< float >	patchData1D () const

bool	isInsideFiducialRegion (unsigned int wire, float drift) const

bool	isCurrentPatch (unsigned int wire, float drift) const

bool	isSamePatch (unsigned int wire1, float drift1, unsigned int wire2, float drift2) const
	test if two wire/drift coordinates point to the same patch More...

Public Member Functions inherited from img::DataProviderAlg
	DataProviderAlg (const fhicl::ParameterSet &pset)

	DataProviderAlg (const Config &config)

virtual	~DataProviderAlg ()

bool	setWireDriftData (const detinfo::DetectorClocksData &clock_data, const detinfo::DetectorPropertiesData &det_prop, const std::vector< recob::Wire > &wires, unsigned int plane, unsigned int tpc, unsigned int cryo)

std::vector< float > const &	wireData (size_t widx) const

std::vector< std::vector< float > >	getPatch (size_t wire, float drift, size_t patchSizeW, size_t patchSizeD) const

float	getPixelOrZero (int wire, int drift) const

double	getAdcSum () const

size_t	getAdcArea () const

float	poolMax (int wire, int drift, size_t r=0) const
	Pool max value in a patch around the wire/drift pixel. More...

unsigned int	Cryo () const
	Pool sum of pixels in a patch around the wire/drift pixel. More...

unsigned int	TPC () const

unsigned int	Plane () const

unsigned int	NWires () const

unsigned int	NScaledDrifts () const

unsigned int	NCachedDrifts () const

unsigned int	DriftWindow () const

float	ZeroLevel () const
	Level of zero ADC after scaling. More...

double	LifetimeCorrection (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, double tick) const

Static Public Member Functions
static std::vector< float >	flattenData2D (std::vector< std::vector< float >> const &patch)

Private Member Functions
bool	bufferPatch (size_t wire, float drift, std::vector< std::vector< float >> &patch) const

bool	bufferPatch (size_t wire, float drift) const

void	resizePatch ()

void	deleteNNet ()

Private Attributes
std::string	fNNetModelFilePath

std::vector< std::string >	fNNetOutputs

nnet::ModelInterface *	fNNet

std::vector< std::vector< float > >	fWireDriftPatch

size_t	fPatchSizeW

size_t	fPatchSizeD

size_t	fCurrentWireIdx

size_t	fCurrentScaledDrift

Additional Inherited Members
Public Types inherited from img::DataProviderAlg
enum	EDownscaleMode { kMax = 1, kMaxMean = 2, kMean = 3 }

Protected Member Functions inherited from img::DataProviderAlg
std::vector< float >	downscaleMax (std::size_t dst_size, std::vector< float > const &adc, size_t tick0) const

std::vector< float >	downscaleMaxMean (std::size_t dst_size, std::vector< float > const &adc, size_t tick0) const

std::vector< float >	downscaleMean (std::size_t dst_size, std::vector< float > const &adc, size_t tick0) const

std::vector< float >	downscale (std::size_t dst_size, std::vector< float > const &adc, size_t tick0) const

size_t	getDriftIndex (float drift) const

std::optional< std::vector< float > >	setWireData (std::vector< float > const &adc, size_t wireIdx) const

bool	patchFromDownsampledView (size_t wire, float drift, size_t size_w, size_t size_d, std::vector< std::vector< float >> &patch) const

bool	patchFromOriginalView (size_t wire, float drift, size_t size_w, size_t size_d, std::vector< std::vector< float >> &patch) const

virtual DataProviderAlgView	resizeView (detinfo::DetectorClocksData const &clock_data, detinfo::DetectorPropertiesData const &det_prop, size_t wires, size_t drifts)

Protected Attributes inherited from img::DataProviderAlg
DataProviderAlgView	fAlgView

EDownscaleMode	fDownscaleMode

size_t	fDriftWindow

bool	fDownscaleFullView

float	fDriftWindowInv

calo::CalorimetryAlg	fCalorimetryAlg

geo::GeometryCore const *	fGeometry

Detailed Description

Definition at line 88 of file PointIdAlg.h.

Constructor & Destructor Documentation

nnet::PointIdAlg::PointIdAlg ( const fhicl::ParameterSet & pset )

inline

Definition at line 104 of file PointIdAlg.h.

104 : PointIdAlg(fhicl::Table<Config>(pset, {})()) {}

fhicl::Table< Config >

nnet::PointIdAlg::PointIdAlg

PointIdAlg(const fhicl::ParameterSet &pset)

Definition: PointIdAlg.h:104

nnet::PointIdAlg::PointIdAlg ( const Config & config )

Definition at line 152 of file PointIdAlg.cxx.

   : img::DataProviderAlg(config)
   , fNNet(0)
   , fPatchSizeW(config.PatchSizeW())
   , fPatchSizeD(config.PatchSizeD())
   , fCurrentWireIdx(99999)
   , fCurrentScaledDrift(99999)
 {
   fNNetModelFilePath = config.NNetModelFile();
   fNNetOutputs = config.NNetOutputs();
 
   deleteNNet();
 
   if ((fNNetModelFilePath.length() > 5) &&
       (fNNetModelFilePath.compare(fNNetModelFilePath.length() - 5, 5, ".nnet") == 0)) {
     fNNet = new nnet::KerasModelInterface(fNNetModelFilePath.c_str());
   }
   else if ((fNNetModelFilePath.length() > 3) &&
            (fNNetModelFilePath.compare(fNNetModelFilePath.length() - 3, 3, ".pb") == 0)) {
     fNNet = new nnet::TfModelInterface(fNNetModelFilePath.c_str());
   }
   else {
     mf::LogError("PointIdAlg") << "File name extension not supported.";
   }
 
   if (!fNNet) { throw cet::exception("nnet::PointIdAlg") << "Loading model from file failed."; }
 
   resizePatch();
 }

nnet::PointIdAlg::~PointIdAlg ( )

override

Definition at line 183 of file PointIdAlg.cxx.

 {
   deleteNNet();
 }

Member Function Documentation

bool nnet::PointIdAlg::bufferPatch	(	size_t	wire,
		float	drift,
		std::vector< std::vector< float >> &	patch
	)		const

inlineprivate

Definition at line 158 of file PointIdAlg.h.

   {
     if (fDownscaleFullView) {
       size_t sd = (size_t)(drift / fDriftWindow);
       if ((fCurrentWireIdx == wire) && (fCurrentScaledDrift == sd))
         return true; // still within the current position
 
       fCurrentWireIdx = wire;
       fCurrentScaledDrift = sd;
 
       return patchFromDownsampledView(wire, drift, fPatchSizeW, fPatchSizeD, patch);
     }
     else {
       if ((fCurrentWireIdx == wire) && (fCurrentScaledDrift == drift))
         return true; // still within the current position
 
       fCurrentWireIdx = wire;
       fCurrentScaledDrift = drift;
 
       return patchFromOriginalView(wire, drift, fPatchSizeW, fPatchSizeD, patch);
     }
   }

bool nnet::PointIdAlg::bufferPatch	(	size_t	wire,
		float	drift
	)		const

inlineprivate

Definition at line 181 of file PointIdAlg.h.

   {
     return bufferPatch(wire, drift, fWireDriftPatch);
   }

void nnet::PointIdAlg::deleteNNet ( )

inlineprivate

Definition at line 188 of file PointIdAlg.h.

   {
     if (fNNet) delete fNNet;
     fNNet = 0;
   }

std::vector< float > nnet::PointIdAlg::flattenData2D ( std::vector< std::vector< float >> const & patch )

static

Definition at line 294 of file PointIdAlg.cxx.

 {
   std::vector<float> flat;
   if (patch.empty() || patch.front().empty()) {
     mf::LogError("DataProviderAlg") << "Patch is empty.";
     return flat;
   }
 
   flat.resize(patch.size() * patch.front().size());
 
   for (size_t w = 0, i = 0; w < patch.size(); ++w) {
     auto const& wire = patch[w];
     for (size_t d = 0; d < wire.size(); ++d, ++i) {
       flat[i] = wire[d];
     }
   }
 
   return flat;
 }

bool nnet::PointIdAlg::isCurrentPatch	(	unsigned int	wire,
		float	drift
	)		const

test if wire/drift coordinates point to the current patch (so maybe the cnn output does not need to be recalculated)

Definition at line 277 of file PointIdAlg.cxx.

 {
   if (fDownscaleFullView) {
     size_t sd = (size_t)(drift / fDriftWindow);
     if ((fCurrentWireIdx == wire) && (fCurrentScaledDrift == sd))
       return true; // still within the current position
   }
   else {
     if ((fCurrentWireIdx == wire) && (fCurrentScaledDrift == drift))
       return true; // still within the current position
   }
 
   return false; // not a current position
 }

bool nnet::PointIdAlg::isInsideFiducialRegion	(	unsigned int	wire,
		float	drift
	)		const

Definition at line 316 of file PointIdAlg.cxx.

 {
   size_t marginW = fPatchSizeW / 8; // fPatchSizeX/2 will make patch always completely filled
   size_t marginD = fPatchSizeD / 8;
 
   size_t scaledDrift = (size_t)(drift / fDriftWindow);
   if ((wire >= marginW) && (wire < fAlgView.fNWires - marginW) && (scaledDrift >= marginD) &&
       (scaledDrift < fAlgView.fNScaledDrifts - marginD))
     return true;
   else
     return false;
 }

bool nnet::PointIdAlg::isSamePatch	(	unsigned int	wire1,
		float	drift1,
		unsigned int	wire2,
		float	drift2
	)		const

test if two wire/drift coordinates point to the same patch

Definition at line 259 of file PointIdAlg.cxx.

 {
   if (fDownscaleFullView) {
     size_t sd1 = (size_t)(drift1 / fDriftWindow);
     size_t sd2 = (size_t)(drift2 / fDriftWindow);
     if ((wire1 == wire2) && (sd1 == sd2)) return true; // the same position
   }
   else {
     if ((wire1 == wire2) && ((size_t)drift1 == (size_t)drift2)) return true; // the same position
   }
 
   return false; // not the same position
 }

std::vector<std::string> const& nnet::PointIdAlg::outputLabels ( ) const

inline

network output labels

Definition at line 112 of file PointIdAlg.h.

   {
     return fNNetOutputs;
   }

std::vector<float> nnet::PointIdAlg::patchData1D ( ) const

inline

Definition at line 134 of file PointIdAlg.h.

   {
     return flattenData2D(fWireDriftPatch);
   } // flat vector made of the patch data, wire after wire

std::vector<std::vector<float> > const& nnet::PointIdAlg::patchData2D ( ) const

inline

Definition at line 129 of file PointIdAlg.h.

   {
     return fWireDriftPatch;
   }

float nnet::PointIdAlg::predictIdValue	(	unsigned int	wire,
		float	drift,
		size_t	outIdx = `0`
	)		const

calculate single-value prediction (2-class probability) for [wire, drift] point

Definition at line 199 of file PointIdAlg.cxx.

 {
   float result = 0.;
 
   if (!bufferPatch(wire, drift)) {
     mf::LogError("PointIdAlg") << "Patch buffering failed.";
     return result;
   }
 
   if (fNNet) {
     auto out = fNNet->Run(fWireDriftPatch);
     if (!out.empty()) { result = out[outIdx]; }
     else {
       mf::LogError("PointIdAlg") << "Problem with applying model to input.";
     }
   }
 
   return result;
 }

std::vector< float > nnet::PointIdAlg::predictIdVector	(	unsigned int	wire,
		float	drift
	)		const

calculate multi-class probabilities for [wire, drift] point

Definition at line 221 of file PointIdAlg.cxx.

 {
   std::vector<float> result;
 
   if (!bufferPatch(wire, drift)) {
     mf::LogError("PointIdAlg") << "Patch buffering failed.";
     return result;
   }
 
   if (fNNet) {
     result = fNNet->Run(fWireDriftPatch);
     if (result.empty()) { mf::LogError("PointIdAlg") << "Problem with applying model to input."; }
   }
 
   return result;
 }

std::vector< std::vector< float > > nnet::PointIdAlg::predictIdVectors ( std::vector< std::pair< unsigned int, float >> points ) const

Definition at line 240 of file PointIdAlg.cxx.

 {
   if (points.empty() || !fNNet) { return std::vector<std::vector<float>>(); }
 
   std::vector<std::vector<std::vector<float>>> inps(
     points.size(), std::vector<std::vector<float>>(fPatchSizeW, std::vector<float>(fPatchSizeD)));
   for (size_t i = 0; i < points.size(); ++i) {
     unsigned int wire = points[i].first;
     float drift = points[i].second;
     if (!bufferPatch(wire, drift, inps[i])) {
       throw cet::exception("PointIdAlg") << "Patch buffering failed" << std::endl;
     }
   }
 
   return fNNet->Run(inps);
 }

void nnet::PointIdAlg::resizePatch ( )

private

Definition at line 190 of file PointIdAlg.cxx.

 {
   fWireDriftPatch.resize(fPatchSizeW);
   for (auto& r : fWireDriftPatch)
     r.resize(fPatchSizeD);
 }

Member Data Documentation

size_t nnet::PointIdAlg::fCurrentScaledDrift

mutableprivate

Definition at line 156 of file PointIdAlg.h.

size_t nnet::PointIdAlg::fCurrentWireIdx

mutableprivate

Definition at line 156 of file PointIdAlg.h.

nnet::ModelInterface* nnet::PointIdAlg::fNNet

private

Definition at line 151 of file PointIdAlg.h.

std::string nnet::PointIdAlg::fNNetModelFilePath

private

Definition at line 149 of file PointIdAlg.h.

std::vector<std::string> nnet::PointIdAlg::fNNetOutputs

private

Definition at line 150 of file PointIdAlg.h.

size_t nnet::PointIdAlg::fPatchSizeD

private

Definition at line 154 of file PointIdAlg.h.

size_t nnet::PointIdAlg::fPatchSizeW

private

Definition at line 154 of file PointIdAlg.h.

std::vector<std::vector<float> > nnet::PointIdAlg::fWireDriftPatch

mutableprivate

Definition at line 153 of file PointIdAlg.h.

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

larrecodnn/larrecodnn/ImagePatternAlgs/Tensorflow/PointIdAlg/PointIdAlg.h
larrecodnn/larrecodnn/ImagePatternAlgs/Tensorflow/PointIdAlg/PointIdAlg.cxx

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation