lcvn Namespace Reference

Utility class for truth labels. More...

Classes
class	AssignLabels
class	Boundary
class	CVNImageUtils
	Class containing some utility functions for all things CVN. More...
class	HitHelper
class	ICVNMapper
class	ICVNZlibMaker
class	ITFNetHandler
	Wrapper for caffe::Net which handles construction and prediction. More...
class	LArCVNEvaluator
class	LArNuCVNZlibMaker
class	LArTrainingData
	The TrainingData objects contains a PixelMap and the output class type, and any other bit that goes into the ANN. More...
class	PixelMap
	PixelMap, basic input to CVN neural net. More...
class	PixelMapProducer
	Producer algorithm for PixelMap, input to CVN neural net. More...
class	Result
	Result, basic output of CVN neural net. More...
class	SimChannelHelper
class	TDNuInfo
class	WireHelper

Typedefs
typedef std::vector< std::vector< unsigned char > >	ViewVector
	Useful typedefs. More...
typedef std::vector< ViewVector >	ImageVector
typedef std::vector< std::vector< float > >	ViewVectorF
typedef std::vector< ViewVectorF >	ImageVectorF
typedef LArTrainingData< lcvn::TDNuInfo >	LArTrainingNuData
typedef std::vector< std::map< double, double > >	Waveform
typedef PixelMapProducer< recob::Hit, lcvn::HitHelper >	PixelMapHitProducer
typedef PixelMapProducer< recob::Wire, lcvn::WireHelper >	PixelMapWireProducer
typedef PixelMapProducer< sim::SimChannel, lcvn::SimChannelHelper >	PixelMapSimProducer
typedef ICVNMapper< lcvn::PixelMapHitProducer, recob::Hit >	LArCVNHitMapper
typedef ICVNMapper< lcvn::PixelMapSimProducer, sim::SimChannel >	LArCVNSimMapper
typedef ICVNMapper< lcvn::PixelMapWireProducer, recob::Wire >	LArCVNWireMapper

Enumerations
enum	HitType {   kElectronHit, kMuonHit, kProtonHit, kNeutronHit,   kPionHit, kPiZeroHit, kGammaHit, kOtherPDGhit,   kUnknownHit, kEmptyHit }
enum	InteractionType {   kNumuQE, kNumuRes, kNumuDIS, kNumuOther,   kNueQE, kNueRes, kNueDIS, kNueOther,   kNutauQE, kNutauRes, kNutauDIS, kNutauOther,   kNuElectronElastic, kNC, kCosmic, kOther,   kNIntType }
enum	TFResultType {   kTFNumuQE, kTFNumuRes, kTFNumuDIS, kTFNumuOther,   kTFNueQE, kTFNueRes, kTFNueDIS, kTFNueOther,   kTFNutauQE, kTFNutauRes, kTFNutauDIS, kTFNutauOther,   kTFNC }
	Enumeration to describe the order of the TF network output. More...
enum	TFMultioutputs {   is_antineutrino, flavour, interaction, protons,   pions, pizeros, neutrons }
enum	TFIsAntineutrino { kNeutrino, kAntineutrino }
enum	TFFlavour { kFlavNumuCC, kFlavNueCC, kFlavNutauCC, kFlavNC }
enum	TFInteraction { kInteQECC, kInteResCC, kInteDISCC, kInteOtherCC }
enum	TFTopologyProtons { kTop0proton, kTop1proton, kTop2proton, kTopNproton }
enum	TFTopologyPions { kTop0pion, kTop1pion, kTop2pion, kTopNpion }
enum	TFTopologyPizeros { kTop0pizero, kTop1pizero, kTop2pizero, kTopNpizero }
enum	TFTopologyNeutrons { kTop0neutron, kTop1neutron, kTop2neutron, kTopNneutron }
enum	TauType { kNotNutau, kNutauE, kNutauMu, kNutauHad }
enum	TopologyType {   kTopNue, kTopNumu, kTopNutauE, kTopNutauMu,   kTopNutauHad, kTopNC }
enum	TopologyTypeAlt { kTopNueLike, kTopNumuLike, kTopNutauLike, kTopNCLike }

Functions
std::ostream &	operator<< (std::ostream &os, const Boundary &b)
std::ostream &	operator<< (std::ostream &os, const TDNuInfo &td)
std::ostream &	operator<< (std::ostream &os, const PixelMap &m)
template<class T , class U >
std::ostream &	operator<< (std::ostream &os, const PixelMapProducer< T, U > &p)

Detailed Description

Utility class for truth labels.

The TrainingData objects contains a PixelMap and the output class type, and any other bit that goes into the ANN.

The LArTrainingData objects contains a PixelMap and the output class type, and any other bit that goes into the ANN.

Defines an enumeration for interaction type.

Defines an enumeration for cellhit classification.

Typedef Documentation

typedef std::vector<ViewVector> lcvn::ImageVector

Definition at line 18 of file CVNImageUtils.h.

typedef std::vector<ViewVectorF> lcvn::ImageVectorF

Definition at line 20 of file CVNImageUtils.h.

typedef ICVNMapper<lcvn::PixelMapHitProducer, recob::Hit> lcvn::LArCVNHitMapper

Definition at line 10 of file LArCVNHitMapper_module.cc.

typedef ICVNMapper<lcvn::PixelMapSimProducer, sim::SimChannel> lcvn::LArCVNSimMapper

Definition at line 10 of file LArCVNSimMapper_module.cc.

typedef ICVNMapper<lcvn::PixelMapWireProducer, recob::Wire> lcvn::LArCVNWireMapper

Definition at line 10 of file LArCVNWireMapper_module.cc.

typedef LArTrainingData<lcvn::TDNuInfo> lcvn::LArTrainingNuData

Definition at line 78 of file LArTrainingData.h.

typedef PixelMapProducer<recob::Hit, lcvn::HitHelper> lcvn::PixelMapHitProducer

Definition at line 136 of file PixelMapProducer.h.

typedef PixelMapProducer<sim::SimChannel, lcvn::SimChannelHelper> lcvn::PixelMapSimProducer

Definition at line 138 of file PixelMapProducer.h.

typedef PixelMapProducer<recob::Wire, lcvn::WireHelper> lcvn::PixelMapWireProducer

Definition at line 137 of file PixelMapProducer.h.

typedef std::vector<std::vector<unsigned char> > lcvn::ViewVector

Useful typedefs.

Definition at line 17 of file CVNImageUtils.h.

typedef std::vector<std::vector<float> > lcvn::ViewVectorF

Definition at line 19 of file CVNImageUtils.h.

typedef std::vector<std::map<double, double> > lcvn::Waveform

Definition at line 33 of file PixelMapProducer.h.

Enumeration Type Documentation

enum lcvn::HitType

Enumerator
kElectronHit
kMuonHit
kProtonHit
kNeutronHit
kPionHit
kPiZeroHit
kGammaHit
kOtherPDGhit
kUnknownHit
kEmptyHit

Definition at line 12 of file HitType.h.

               {
    kElectronHit,
    kMuonHit,
    kProtonHit,
    kNeutronHit,
    kPionHit,
    kPiZeroHit,
    kGammaHit,
    kOtherPDGhit,
    kUnknownHit,
    kEmptyHit
  };

enum lcvn::InteractionType

Enumerator
kNumuQE	Numu CC QE interaction.
kNumuRes	Numu CC Resonant interaction.
kNumuDIS	Numu CC DIS interaction.
kNumuOther	Numu CC, other than above.
kNueQE	Nue CC QE interaction.
kNueRes	Nue CC Resonant interaction.
kNueDIS	Nue CC DIS interaction.
kNueOther	Nue CC, other than above.
kNutauQE	Nutau CC QE interaction.
kNutauRes	Nutau CC Resonant interaction.
kNutauDIS	Nutau CC DIS interaction.
kNutauOther	Nutau CC, other than above.
kNuElectronElastic	NC Nu On E Scattering.
kNC	NC interaction.
kCosmic	Cosmic ray background.
kOther	Something else. Tau? Hopefully we don't use this.
kNIntType	Number of interaction types, used like a vector size.

Definition at line 15 of file InteractionType.h.

                       {
    kNumuQE,            
    kNumuRes,           
    kNumuDIS,           
    kNumuOther,         
    kNueQE,             
    kNueRes,            
    kNueDIS,            
    kNueOther,          
    kNutauQE,           
    kNutauRes,          
    kNutauDIS,          
    kNutauOther,        
    kNuElectronElastic, 
    kNC,                
    kCosmic,            
    kOther,             
    kNIntType           
  };

enum lcvn::TauType

Enumerator
kNotNutau
kNutauE
kNutauMu
kNutauHad

Definition at line 117 of file InteractionType.h.

{ kNotNutau, kNutauE, kNutauMu, kNutauHad };

enum lcvn::TFFlavour

Enumerator
kFlavNumuCC
kFlavNueCC
kFlavNutauCC
kFlavNC

Definition at line 59 of file InteractionType.h.

{ kFlavNumuCC, kFlavNueCC, kFlavNutauCC, kFlavNC };

enum lcvn::TFInteraction

Enumerator
kInteQECC
kInteResCC
kInteDISCC
kInteOtherCC

Definition at line 62 of file InteractionType.h.

{ kInteQECC, kInteResCC, kInteDISCC, kInteOtherCC };

enum lcvn::TFIsAntineutrino

Enumerator
kNeutrino
kAntineutrino

Definition at line 56 of file InteractionType.h.

{ kNeutrino, kAntineutrino };

enum lcvn::TFMultioutputs

Enumerator
is_antineutrino
flavour
interaction
protons
pions
pizeros
neutrons

Definition at line 53 of file InteractionType.h.

{ is_antineutrino, flavour, interaction, protons, pions, pizeros, neutrons };

enum lcvn::TFResultType

Enumeration to describe the order of the TF network output.

Enumerator
kTFNumuQE	Numu CC QE interaction.
kTFNumuRes	Numu CC Resonant interaction.
kTFNumuDIS	Numu CC DIS interaction.
kTFNumuOther	Numu CC, other than above.
kTFNueQE	Nue CC QE interaction.
kTFNueRes	Nue CC Resonant interaction.
kTFNueDIS	Nue CC DIS interaction.
kTFNueOther	Nue CC, other than above.
kTFNutauQE	Nutau CC QE interaction.
kTFNutauRes	Nutau CC Resonant interaction.
kTFNutauDIS	Nutau CC DIS interaction.
kTFNutauOther	Nutau CC, other than above.
kTFNC	NC interaction.

Definition at line 36 of file InteractionType.h.

                    {
    kTFNumuQE,     
    kTFNumuRes,    
    kTFNumuDIS,    
    kTFNumuOther,  
    kTFNueQE,      
    kTFNueRes,     
    kTFNueDIS,     
    kTFNueOther,   
    kTFNutauQE,    
    kTFNutauRes,   
    kTFNutauDIS,   
    kTFNutauOther, 
    kTFNC          
  };

enum lcvn::TFTopologyNeutrons

Enumerator
kTop0neutron
kTop1neutron
kTop2neutron
kTopNneutron

Definition at line 74 of file InteractionType.h.

{ kTop0neutron, kTop1neutron, kTop2neutron, kTopNneutron };

enum lcvn::TFTopologyPions

Enumerator
kTop0pion
kTop1pion
kTop2pion
kTopNpion

Definition at line 68 of file InteractionType.h.

{ kTop0pion, kTop1pion, kTop2pion, kTopNpion };

enum lcvn::TFTopologyPizeros

Enumerator
kTop0pizero
kTop1pizero
kTop2pizero
kTopNpizero

Definition at line 71 of file InteractionType.h.

{ kTop0pizero, kTop1pizero, kTop2pizero, kTopNpizero };

enum lcvn::TFTopologyProtons

Enumerator
kTop0proton
kTop1proton
kTop2proton
kTopNproton

Definition at line 65 of file InteractionType.h.

{ kTop0proton, kTop1proton, kTop2proton, kTopNproton };

enum lcvn::TopologyType

Enumerator
kTopNue
kTopNumu
kTopNutauE
kTopNutauMu
kTopNutauHad
kTopNC

Definition at line 119 of file InteractionType.h.

{ kTopNue, kTopNumu, kTopNutauE, kTopNutauMu, kTopNutauHad, kTopNC };

enum lcvn::TopologyTypeAlt

Enumerator
kTopNueLike
kTopNumuLike
kTopNutauLike
kTopNCLike

Definition at line 121 of file InteractionType.h.

{ kTopNueLike, kTopNumuLike, kTopNutauLike, kTopNCLike };

Function Documentation

std::ostream & lcvn::operator<<	(	std::ostream &	os,
		const Boundary &	b
	)

Definition at line 47 of file Boundary.cxx.

References lcvn::Boundary::FirstTDC(), lcvn::Boundary::FirstWire(), lcvn::Boundary::LastTDC(), and lcvn::Boundary::LastWire().

  {
    os << "Boundary with "
       << "(first,last) wire X: (" << b.FirstWire(0) << ", " << b.LastWire(0)
       << "(first,last) wire Y: (" << b.FirstWire(1) << ", " << b.LastWire(1)
       << "(first,last) wire Z: (" << b.FirstWire(2) << ", " << b.LastWire(2)
       << "), (first,last) tdc X: (" << b.FirstTDC(0) << ", " << b.LastTDC(0) << ")"
       << "), (first,last) tdc Y: (" << b.FirstTDC(1) << ", " << b.LastTDC(1) << ")"
       << "), (first,last) tdc Z: (" << b.FirstTDC(2) << ", " << b.LastTDC(2) << ")";

    return os;
  }

std::ostream& lcvn::operator<<	(	std::ostream &	os,
		const TDNuInfo &	td
	)

Definition at line 69 of file LArTrainingData.cxx.

References lcvn::TDNuInfo::fEventWeight, lcvn::TDNuInfo::fLepAngle, lcvn::TDNuInfo::fLepEnergy, lcvn::TDNuInfo::fNNeutron, lcvn::TDNuInfo::fNPion, lcvn::TDNuInfo::fNPizero, lcvn::TDNuInfo::fNProton, lcvn::TDNuInfo::fNuEnergy, lcvn::TDNuInfo::fNuPDG, lcvn::TDNuInfo::fRecoNueEnergy, lcvn::TDNuInfo::fRecoNumuEnergy, lcvn::TDNuInfo::fRecoNutauEnergy, lcvn::TDNuInfo::fTopologyType, and lcvn::TDNuInfo::fTopologyTypeAlt.

  {
    // keep this order because the keras python scripts depend on this
    os << td.fNuEnergy << std::endl;
    os << td.fLepEnergy << std::endl;
    os << td.fRecoNueEnergy << std::endl;
    os << td.fRecoNumuEnergy << std::endl;
    os << td.fRecoNutauEnergy << std::endl;
    os << td.fEventWeight << std::endl;

    os << td.fNuPDG << std::endl;
    os << td.fNProton << std::endl;
    os << td.fNPion << std::endl;
    os << td.fNPizero << std::endl;
    os << td.fNNeutron << std::endl;

    os << td.fTopologyType << std::endl;
    os << td.fTopologyTypeAlt << std::endl;
    os << td.fLepAngle << std::endl;

    return os;
  }

template<class T , class U >

std::ostream& lcvn::operator<<	(	std::ostream &	os,
		const PixelMapProducer< T, U > &	p
	)

Definition at line 194 of file PixelMapProducer.cxx.

References lcvn::PixelMap::NTdc().

  {
    os << "PixelMapProducer: " << p.NTdc() << " tdcs X  " << p.NWire() << " wires";
    return os;
  }

std::ostream & lcvn::operator<<	(	std::ostream &	os,
		const PixelMap &	m
	)

Definition at line 206 of file PixelMap.cxx.

References lcvn::PixelMap::NPixel(), lcvn::PixelMap::NTdc(), and lcvn::PixelMap::NWire().

  {
    os << "PixelMap with " << m.NPixel() << " pixels, " << m.NWire() << " wires"
       << " by " << m.NTdc() << " tdcs";
    return os;
  }