WireCell::IDiffusion Class Reference

#include <IDiffusion.h>

Inheritance diagram for WireCell::IDiffusion:

Public Member Functions
virtual	~IDiffusion ()

virtual IDepo::pointer	depo () const =0
	Return the deposition that led to this diffusion. More...

virtual double	get (int lind, int tind) const =0
	Get value at bin. More...

virtual int	lsize () const =0
	Helper method to give the array size in longitudinal dimension. More...

virtual int	tsize () const =0
	Helper method to give the array size in transverse dimension. More...

virtual double	lpos (int ind, double offset=0.0) const =0

virtual double	tpos (int ind, double offset=0.0) const =0

double	lbegin () const
	Return begin of diffusion patch in longitudinal direction. More...

double	tbegin () const
	Return begin of diffusion patch in transverse direction. More...

double	lend () const
	Return end of diffusion patch in longitudinal direction. More...

double	tend () const
	Return end of diffusion patch in transverse direction. More...

double	lbin () const
	Return bins size in longitudinal direction. More...

double	tbin () const
	Return bins size in transverse direction. More...

Public Member Functions inherited from WireCell::IData< IDiffusion >
virtual	~IData ()

Additional Inherited Members
Public Types inherited from WireCell::IData< IDiffusion >
typedef IDiffusion	value_type

typedef std::shared_ptr< const IDiffusion >	pointer

typedef std::vector< pointer >	vector

typedef std::shared_ptr< const vector >	shared_vector

Detailed Description

An interface to information about charge which has diffused in longitudinal and transverse directions.

The diffusion is a rectangular patch of (charge) values on a regular grid defined in longitudinal vs. transverse space. Bins are typically tick vs. wire pitch or vs. impact position.

See also WireCell::IDiffuser which is one interface that produces these objects.

Definition at line 19 of file IDiffusion.h.

Constructor & Destructor Documentation

IDiffusion::~IDiffusion ( )

virtual

Definition at line 125 of file IfaceDesctructors.cxx.

125 {}

Member Function Documentation

virtual IDepo::pointer WireCell::IDiffusion::depo ( ) const

pure virtual

Return the deposition that led to this diffusion.

Implemented in WireCell::Diffusion.

virtual double WireCell::IDiffusion::get	(	int	lind,
		int	tind
	)		const

pure virtual

Get value at bin.

Implemented in WireCell::Diffusion.

double WireCell::IDiffusion::lbegin ( ) const

inline

Return begin of diffusion patch in longitudinal direction.

Definition at line 44 of file IDiffusion.h.

44 { return lpos(0); }

WireCell::IDiffusion::lpos

virtual double lpos(int ind, double offset=0.0) const =0

double WireCell::IDiffusion::lbin ( ) const

inline

Return bins size in longitudinal direction.

Definition at line 52 of file IDiffusion.h.

52 { return lpos(1) - lpos(0); }

WireCell::IDiffusion::lpos

virtual double lpos(int ind, double offset=0.0) const =0

double WireCell::IDiffusion::lend ( ) const

inline

Return end of diffusion patch in longitudinal direction.

Definition at line 48 of file IDiffusion.h.

48 { return lpos(lsize()); }

WireCell::IDiffusion::lsize

virtual int lsize() const =0

Helper method to give the array size in longitudinal dimension.

WireCell::IDiffusion::lpos

virtual double lpos(int ind, double offset=0.0) const =0

virtual double WireCell::IDiffusion::lpos	(	int	ind,
		double	offset = `0.0`
	)		const

pure virtual

Implemented in WireCell::Diffusion.

virtual int WireCell::IDiffusion::lsize ( ) const

pure virtual

Helper method to give the array size in longitudinal dimension.

Implemented in WireCell::Diffusion.

double WireCell::IDiffusion::tbegin ( ) const

inline

Return begin of diffusion patch in transverse direction.

Definition at line 46 of file IDiffusion.h.

46 { return tpos(0); }

WireCell::IDiffusion::tpos

virtual double tpos(int ind, double offset=0.0) const =0

double WireCell::IDiffusion::tbin ( ) const

inline

Return bins size in transverse direction.

Definition at line 54 of file IDiffusion.h.

54 { return tpos(1) - tpos(0); }

WireCell::IDiffusion::tpos

virtual double tpos(int ind, double offset=0.0) const =0

double WireCell::IDiffusion::tend ( ) const

inline

Return end of diffusion patch in transverse direction.

Definition at line 50 of file IDiffusion.h.

50 { return tpos(tsize()); }

WireCell::IDiffusion::tsize

virtual int tsize() const =0

Helper method to give the array size in transverse dimension.

WireCell::IDiffusion::tpos

virtual double tpos(int ind, double offset=0.0) const =0

virtual double WireCell::IDiffusion::tpos	(	int	ind,
		double	offset = `0.0`
	)		const

pure virtual

Implemented in WireCell::Diffusion.

virtual int WireCell::IDiffusion::tsize ( ) const

pure virtual

Helper method to give the array size in transverse dimension.

Implemented in WireCell::Diffusion.

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

wire-cell-build/iface/inc/WireCellIface/IDiffusion.h
wire-cell-build/iface/src/IfaceDesctructors.cxx