cvn::SparsePixelMap Class Reference

#include <SparsePixelMap.h>

Public Member Functions
	SparsePixelMap (unsigned int dim, unsigned int views, bool usePixelTruth=false)
	SparsePixelMap ()
	~SparsePixelMap ()
void	AddHit (unsigned int view, std::vector< float > coordinates, std::vector< float > features)
	Default AddHit implementation, which just adds pixel value and coordinates. More...
void	AddHit (unsigned int view, std::vector< float > coordinates, std::vector< float > features, std::vector< int > pdgs, std::vector< int > tracks, std::vector< float > energies, std::vector< std::string > processes)
	AddHit function that includes per-pixel truth labelling for segmentation. More...
unsigned int	GetDim () const
unsigned int	GetViews () const
std::vector< unsigned int >	GetNPixels () const
unsigned int	GetNPixels (size_t view) const
std::vector< std::vector< std::vector< float > > >	GetCoordinates () const
std::vector< std::vector< float > >	GetCoordinates (size_t view) const
std::vector< std::vector< std::vector< float > > >	GetFeatures () const
std::vector< std::vector< float > >	GetFeatures (size_t view) const
std::vector< std::vector< std::vector< int > > >	GetPixelPDGs () const
std::vector< std::vector< int > >	GetPixelPDGs (size_t view) const
std::vector< std::vector< std::vector< int > > >	GetPixelTrackIDs () const
std::vector< std::vector< int > >	GetPixelTrackIDs (size_t view) const
std::vector< std::vector< std::vector< float > > >	GetPixelEnergies () const
std::vector< std::vector< float > >	GetPixelEnergies (size_t view) const
std::vector< std::vector< std::vector< std::string > > >	GetProcesses () const
std::vector< std::vector< std::string > >	GetProcesses (size_t view) const

Private Member Functions
template<class T >
std::vector< T >	FlattenVector (std::vector< std::vector< T >> vec) const

Private Attributes
unsigned int	fDim
	Dimensionality of each pixel map. More...
unsigned int	fViews
	Number of views. More...
bool	fUsePixelTruth
	Whether to use a per-pixel ground truth for pixel segmentation. More...
std::vector< std::vector< std::vector< float > > >	fCoordinates
	Coordinates of non-zero pixels. More...
std::vector< std::vector< std::vector< float > > >	fFeatures
	Features of non-zero pixels. More...
std::vector< std::vector< std::vector< int > > >	fPixelPDGs
	True particle PDG responsible for pixel. More...
std::vector< std::vector< std::vector< int > > >	fPixelTrackIDs
	G4 track IDs responsible for pixelel. More...
std::vector< std::vector< std::vector< float > > >	fPixelEnergies
std::vector< std::vector< std::vector< std::string > > >	fProcesses

Detailed Description

Definition at line 14 of file SparsePixelMap.h.

Constructor & Destructor Documentation

cvn::SparsePixelMap::SparsePixelMap	(	unsigned int	dim,
		unsigned int	views,
		bool	usePixelTruth = false
	)

Definition at line 14 of file SparsePixelMap.cxx.

    : fDim(dim), fViews(views), fUsePixelTruth(usePixelTruth)
  {
    fCoordinates.resize(fViews);
    fFeatures.resize(fViews);
    if (fUsePixelTruth) {
      fPixelPDGs.resize(fViews);
      fPixelTrackIDs.resize(fViews);
      fPixelEnergies.resize(fViews);
      fProcesses.resize(fViews);
// *******************************************
    }
  }

cvn::SparsePixelMap::SparsePixelMap ( )

inline

Definition at line 18 of file SparsePixelMap.h.

{};

cvn::SparsePixelMap::~SparsePixelMap ( )

inline

Definition at line 19 of file SparsePixelMap.h.

{};

Member Function Documentation

void cvn::SparsePixelMap::AddHit	(	unsigned int	view,
		std::vector< float >	coordinates,
		std::vector< float >	features
	)

Default AddHit implementation, which just adds pixel value and coordinates.

Definition at line 29 of file SparsePixelMap.cxx.

                               {

    if (coordinates.size() != fDim) {
      throw art::Exception(art::errors::LogicError)
        << "Coordinate vector with size " << coordinates.size()
        << " does not match sparse pixel map dimension " << fDim;
    }

    if (fUsePixelTruth) {
      throw art::Exception(art::errors::LogicError)
        << "Pixel truth is enabled for this SparsePixelMap, so you must include pixel PDG and "
        << "track ID when calling AddHit.";
    }

    fCoordinates[view].push_back(coordinates);
    fFeatures[view].push_back(features);
  }

void cvn::SparsePixelMap::AddHit	(	unsigned int	view,
		std::vector< float >	coordinates,
		std::vector< float >	features,
		std::vector< int >	pdgs,
		std::vector< int >	tracks,
		std::vector< float >	energies,
		std::vector< std::string >	processes
	)

AddHit function that includes per-pixel truth labelling for segmentation.

Definition at line 49 of file SparsePixelMap.cxx.

                                                               {

    if (coordinates.size() != fDim) {
      throw art::Exception(art::errors::LogicError)
        << "Coordinate vector with size " << coordinates.size()
        << " does not match sparse pixel map dimension " << fDim;
    }

    if (!fUsePixelTruth) {
      throw art::Exception(art::errors::LogicError)
        << "Pixel truth is disabled for this SparsePixelMap, but AddHit call includes "
        << "pixel PDG, track ID and Energy";
    }

    fCoordinates[view].push_back(coordinates);
    fFeatures[view].push_back(features);
    fPixelPDGs[view].push_back(pdgs);
    fPixelTrackIDs[view].push_back(tracks);
    fPixelEnergies[view].push_back(energies);
    fProcesses[view].push_back(processes);

  }

template<class T >

std::vector<T> cvn::SparsePixelMap::FlattenVector ( std::vector< std::vector< T >>  vec ) const

inlineprivate

Definition at line 52 of file SparsePixelMap.h.

                                                                  {
      std::vector<T> ret;
      for (auto it : vec) {
        ret.insert(ret.end(), it.begin(), it.end());
      }
      return ret;
    }

std::vector<std::vector<std::vector<float> > > cvn::SparsePixelMap::GetCoordinates ( ) const

inline

Definition at line 29 of file SparsePixelMap.h.

{ return fCoordinates; };

std::vector<std::vector<float> > cvn::SparsePixelMap::GetCoordinates ( size_t  view ) const

inline

Definition at line 30 of file SparsePixelMap.h.

{ return fCoordinates[view]; };

unsigned int cvn::SparsePixelMap::GetDim ( ) const

inline

Definition at line 24 of file SparsePixelMap.h.

{ return fDim; };

std::vector<std::vector<std::vector<float> > > cvn::SparsePixelMap::GetFeatures ( ) const

inline

Definition at line 32 of file SparsePixelMap.h.

{ return fFeatures; };

std::vector<std::vector<float> > cvn::SparsePixelMap::GetFeatures ( size_t  view ) const

inline

Definition at line 33 of file SparsePixelMap.h.

{ return fFeatures[view]; };

std::vector< unsigned int > cvn::SparsePixelMap::GetNPixels

(

)

const

Definition at line 74 of file SparsePixelMap.cxx.

                                                           {
    
    std::vector<unsigned int> ret(fViews);
    for (size_t it = 0; it < fViews; ++it) {
      ret[it] = fFeatures[it].size();
    }
    return ret;
  }

unsigned int cvn::SparsePixelMap::GetNPixels ( size_t  view ) const

inline

Definition at line 27 of file SparsePixelMap.h.

{ return fFeatures[view].size(); };

std::vector<std::vector<std::vector<float> > > cvn::SparsePixelMap::GetPixelEnergies ( ) const

inline

Definition at line 41 of file SparsePixelMap.h.

{return fPixelEnergies; };

std::vector<std::vector<float> > cvn::SparsePixelMap::GetPixelEnergies ( size_t  view ) const

inline

Definition at line 42 of file SparsePixelMap.h.

{return fPixelEnergies[view]; }; 

std::vector<std::vector<std::vector<int> > > cvn::SparsePixelMap::GetPixelPDGs ( ) const

inline

Definition at line 35 of file SparsePixelMap.h.

{ return fPixelPDGs; };

std::vector<std::vector<int> > cvn::SparsePixelMap::GetPixelPDGs ( size_t  view ) const

inline

Definition at line 36 of file SparsePixelMap.h.

{ return fPixelPDGs[view]; };

std::vector<std::vector<std::vector<int> > > cvn::SparsePixelMap::GetPixelTrackIDs ( ) const

inline

Definition at line 38 of file SparsePixelMap.h.

{return fPixelTrackIDs; };

std::vector<std::vector<int> > cvn::SparsePixelMap::GetPixelTrackIDs ( size_t  view ) const

inline

Definition at line 39 of file SparsePixelMap.h.

{return fPixelTrackIDs[view]; }; 

std::vector<std::vector<std::vector<std::string> > > cvn::SparsePixelMap::GetProcesses ( ) const

inline

Definition at line 44 of file SparsePixelMap.h.

{ return fProcesses; };

std::vector<std::vector<std::string> > cvn::SparsePixelMap::GetProcesses ( size_t  view ) const

inline

Definition at line 45 of file SparsePixelMap.h.

{ return fProcesses[view]; };

unsigned int cvn::SparsePixelMap::GetViews ( ) const

inline

Definition at line 25 of file SparsePixelMap.h.

{ return fViews; }

Member Data Documentation

std::vector<std::vector<std::vector<float> > > cvn::SparsePixelMap::fCoordinates

private

Coordinates of non-zero pixels.

Definition at line 63 of file SparsePixelMap.h.

unsigned int cvn::SparsePixelMap::fDim

private

Dimensionality of each pixel map.

Definition at line 60 of file SparsePixelMap.h.

std::vector<std::vector<std::vector<float> > > cvn::SparsePixelMap::fFeatures

private

Features of non-zero pixels.

Definition at line 64 of file SparsePixelMap.h.

std::vector<std::vector<std::vector<float> > > cvn::SparsePixelMap::fPixelEnergies

private

Definition at line 67 of file SparsePixelMap.h.

std::vector<std::vector<std::vector<int> > > cvn::SparsePixelMap::fPixelPDGs

private

True particle PDG responsible for pixel.

Definition at line 65 of file SparsePixelMap.h.

std::vector<std::vector<std::vector<int> > > cvn::SparsePixelMap::fPixelTrackIDs

private

G4 track IDs responsible for pixelel.

Definition at line 66 of file SparsePixelMap.h.

std::vector<std::vector<std::vector<std::string> > > cvn::SparsePixelMap::fProcesses

private

Definition at line 68 of file SparsePixelMap.h.

bool cvn::SparsePixelMap::fUsePixelTruth

private

Whether to use a per-pixel ground truth for pixel segmentation.

Definition at line 62 of file SparsePixelMap.h.

unsigned int cvn::SparsePixelMap::fViews

private

Number of views.

Definition at line 61 of file SparsePixelMap.h.

---

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

• dunereco/dunereco/CVN/func/SparsePixelMap.h
• dunereco/dunereco/CVN/func/SparsePixelMap.cxx