Public Member Functions | List of all members
WireCell::IDepo Class Referenceabstract

#include <IDepo.h>

Inheritance diagram for WireCell::IDepo:
WireCell::IData< IDepo > WireCell::Gen::TransportedDepo WireCell::SimpleDepo

Public Member Functions

virtual ~IDepo ()
 
virtual const Pointpos () const =0
 The location of the deposition. More...
 
virtual double time () const =0
 
virtual double charge () const =0
 The number charge (in units of number of electrons) deposited. More...
 
virtual double energy () const =0
 The energy (in units of MeV) deposited. More...
 
virtual int id () const =0
 Track ID from Geant4. More...
 
virtual int pdg () const =0
 PDG code from Geant4. More...
 
virtual pointer prior () const =0
 If the deposition is drifted, this may allow access to the original. More...
 
virtual double extent_long () const
 
virtual double extent_tran () const
 
- Public Member Functions inherited from WireCell::IData< IDepo >
virtual ~IData ()
 

Additional Inherited Members

- Public Types inherited from WireCell::IData< IDepo >
typedef IDepo value_type
 
typedef std::shared_ptr< const IDepopointer
 
typedef std::vector< pointervector
 
typedef std::shared_ptr< const vectorshared_vector
 

Detailed Description

An interface to information about a deposition of charge.

Definition at line 14 of file IDepo.h.

Constructor & Destructor Documentation

IDepo::~IDepo ( )
virtual

Definition at line 115 of file IfaceDesctructors.cxx.

115 {}

Member Function Documentation

virtual double WireCell::IDepo::charge ( ) const
pure virtual

The number charge (in units of number of electrons) deposited.

Implemented in WireCell::Gen::TransportedDepo, and WireCell::SimpleDepo.

virtual double WireCell::IDepo::energy ( ) const
pure virtual

The energy (in units of MeV) deposited.

Implemented in WireCell::Gen::TransportedDepo, and WireCell::SimpleDepo.

virtual double WireCell::IDepo::extent_long ( ) const
inlinevirtual

Any (half width) extent in the longitudinal (drift) direction (distance). The distribution is implicit but typically it is taken that this is a Gaussian sigma.

Reimplemented in WireCell::SimpleDepo.

Definition at line 44 of file IDepo.h.

44 { return 0.0; }
virtual double WireCell::IDepo::extent_tran ( ) const
inlinevirtual

Any (half width) extent in the transverse (pitch) direction (distance). The distribution is implicit but typically it is taken that this is a Gaussian sigma.

Reimplemented in WireCell::SimpleDepo.

Definition at line 49 of file IDepo.h.

49 { return 0.0; }
virtual int WireCell::IDepo::id ( ) const
pure virtual

Track ID from Geant4.

Implemented in WireCell::Gen::TransportedDepo, and WireCell::SimpleDepo.

virtual int WireCell::IDepo::pdg ( ) const
pure virtual

PDG code from Geant4.

Implemented in WireCell::Gen::TransportedDepo, and WireCell::SimpleDepo.

virtual const Point& WireCell::IDepo::pos ( ) const
pure virtual

The location of the deposition.

Implemented in WireCell::Gen::TransportedDepo, and WireCell::SimpleDepo.

virtual pointer WireCell::IDepo::prior ( ) const
pure virtual

If the deposition is drifted, this may allow access to the original.

Implemented in WireCell::Gen::TransportedDepo, and WireCell::SimpleDepo.

virtual double WireCell::IDepo::time ( ) const
pure virtual

The number of seconds from some absolute start time to when the deposition occur ed.

Implemented in WireCell::Gen::TransportedDepo, and WireCell::SimpleDepo.


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