A producer of depositions created from some number of simple, linear tracks. More...

#include <TrackDepos.h>

Inheritance diagram for WireCell::Gen::TrackDepos:

Public Types
typedef std::tuple< double, Ray, double >	track_t

Public Types inherited from WireCell::IDepoSource
typedef std::shared_ptr< IDepoSource >	pointer

Public Types inherited from WireCell::ISourceNode< IDepo >
typedef IDepo	output_type

typedef ISourceNode< IDepo >	signature_type

typedef std::shared_ptr< signature_type >	pointer

typedef std::shared_ptr< const IDepo >	output_pointer

Public Types inherited from WireCell::ISourceNodeBase
typedef std::shared_ptr< ISourceNodeBase >	pointer

Public Types inherited from WireCell::INode
enum	NodeCategory { unknown, sourceNode, sinkNode, functionNode, queuedoutNode, joinNode, splitNode, faninNode, fanoutNode, multioutNode, hydraNode }

Public Types inherited from WireCell::IComponent< INode >
typedef std::shared_ptr< INode >	pointer
	Access subclass facet by pointer. More...

typedef std::vector< pointer >	vector
	Vector of shared pointers. More...

Public Types inherited from WireCell::Interface
typedef std::shared_ptr< Interface >	pointer

Public Types inherited from WireCell::IComponent< IConfigurable >
typedef std::shared_ptr< IConfigurable >	pointer
	Access subclass facet by pointer. More...

typedef std::vector< pointer >	vector
	Vector of shared pointers. More...

Public Member Functions
	TrackDepos (double stepsize=1.0 *units::millimeter, double clight=1.0)

virtual	~TrackDepos ()

virtual void	configure (const WireCell::Configuration &config)
	Accept a configuration. More...

virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default configuration. More...

void	add_track (double time, const WireCell::Ray &ray, double dedx=-1.0)

virtual bool	operator() (IDepo::pointer &out)
	ISourceNode. More...

WireCell::IDepo::vector	depos ()

std::vector< track_t >	tracks () const

Public Member Functions inherited from WireCell::IDepoSource
virtual	~IDepoSource ()

virtual std::string	signature ()
	Set the signature for all subclasses. More...

Public Member Functions inherited from WireCell::ISourceNode< IDepo >
virtual	~ISourceNode ()

virtual NodeCategory	category ()
	Return the behavior category type. More...

virtual bool	operator() (boost::any &anyout)

virtual std::vector< std::string >	output_types ()

Public Member Functions inherited from WireCell::ISourceNodeBase
virtual	~ISourceNodeBase ()

Public Member Functions inherited from WireCell::INode
virtual	~INode ()

virtual int	concurrency ()

virtual std::vector< std::string >	input_types ()

virtual void	reset ()

Public Member Functions inherited from WireCell::IComponent< INode >
virtual	~IComponent ()

Public Member Functions inherited from WireCell::Interface
virtual	~Interface ()

Public Member Functions inherited from WireCell::IConfigurable
virtual	~IConfigurable ()

Public Member Functions inherited from WireCell::IComponent< IConfigurable >
virtual	~IComponent ()

Private Attributes
double	m_stepsize

double	m_clight

std::deque< WireCell::IDepo::pointer >	m_depos

std::vector< track_t >	m_tracks

int	m_count

Log::logptr_t	l

Detailed Description

A producer of depositions created from some number of simple, linear tracks.

Definition at line 17 of file TrackDepos.h.

Member Typedef Documentation

typedef std::tuple<double, Ray, double> WireCell::Gen::TrackDepos::track_t

Definition at line 40 of file TrackDepos.h.

Constructor & Destructor Documentation

Gen::TrackDepos::TrackDepos	(	double	stepsize = `1.0*units::millimeter`,
		double	clight = `1.0`
	)

Create tracks with depositions every stepsize and assumed to be traveling at clight.

Definition at line 18 of file TrackDepos.cxx.

     : m_stepsize(stepsize)
     , m_clight(clight)
     , m_count(0)
     , l(Log::logger("sim"))
 {
 }

Gen::TrackDepos::~TrackDepos ( )

virtual

Definition at line 26 of file TrackDepos.cxx.

27 {

28 }

Member Function Documentation

void Gen::TrackDepos::add_track	(	double	time,
		const WireCell::Ray &	ray,
		double	dedx = `-1.0`
	)

Add track starting at given <time> and stretching across given ray. The <dedx> gives a uniform charge/distance and if < 0 then it gives the (negative of) absolute amount of charge per deposition.

Definition at line 85 of file TrackDepos.cxx.

 {
     l->debug("add_track({} us, ({} -> {})cm, {})",
              time/units::us, ray.first/units::cm, ray.second/units::cm, charge);
     m_tracks.push_back(track_t(time, ray, charge));
 
     const WireCell::Vector dir = WireCell::ray_unit(ray);
     const double length = WireCell::ray_length(ray);
     double step = 0;
     int count = 0;
 
     double charge_per_depo = units::eplus; // charge of one positron
     if (charge > 0) {
         charge_per_depo = -charge / (length / m_stepsize);
     }
     else if (charge <= 0) {
         charge_per_depo = charge;
     }
 
     while (step < length) {
         const double now = time + step/(m_clight*units::clight);
         const WireCell::Point here = ray.first + dir * step;
         SimpleDepo* sdepo = new SimpleDepo(now, here, charge_per_depo);
         m_depos.push_back(WireCell::IDepo::pointer(sdepo));
         step += m_stepsize;
         ++count;
     }
 
     // earliest first
     std::sort(m_depos.begin(), m_depos.end(), ascending_time);
     l->debug("depos: {} over {}mm", m_depos.size(), length/units::mm);
 }

void Gen::TrackDepos::configure ( const WireCell::Configuration & config )

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 45 of file TrackDepos.cxx.

 {
     m_stepsize = get<double>(cfg, "step_size", m_stepsize);
     Assert(m_stepsize > 0);
     m_clight = get<double>(cfg, "clight", m_clight);
     for (auto track : cfg["tracks"]) {
         double time = get<double>(track, "time", 0.0);
         double charge = get<double>(track, "charge", -1.0);
         Ray ray = get<Ray>(track, "ray");
         add_track(time, ray, charge);
     }
     double gt = get<double>(cfg, "group_time", -1);
     if (m_depos.empty() or gt <= 0.0) {
         m_depos.push_back(nullptr);
         return;
     }
     std::deque<WireCell::IDepo::pointer> grouped;
     double now = m_depos.front()->time();
     double end = now + gt;
     for (auto depo : m_depos) {
         if (depo->time() < end) {
             grouped.push_back(depo);
             continue;
         }
         grouped.push_back(nullptr);
         now = depo->time();
         end = now + gt;
         grouped.push_back(depo);
     }
     grouped.push_back(nullptr);
     m_depos = grouped;
 }

Configuration Gen::TrackDepos::default_configuration ( ) const

virtual

Optional, override to return a hard-coded default configuration.

Reimplemented from WireCell::IConfigurable.

Definition at line 30 of file TrackDepos.cxx.

 {
     Configuration cfg;
     cfg["step_size"] = 1.0*units::mm;
     cfg["clight"] = 1.0;        // fraction of speed of light the track goes
     cfg["tracks"] = Json::arrayValue;
     cfg["group_time"] = -1;          // if positive then chunk the
                                      // stream of output depos into
                                      // groups delineated by EOS
                                      // markers and such that each
                                      // group spans a time period no
                                      // more than group_time.
     return cfg;
 }

WireCell::IDepo::vector Gen::TrackDepos::depos ( )

Definition at line 137 of file TrackDepos.cxx.

 {
     return WireCell::IDepo::vector(m_depos.begin(), m_depos.end());
 }

bool Gen::TrackDepos::operator() ( IDepo::pointer & out )

virtual

ISourceNode.

Implements WireCell::ISourceNode< IDepo >.

Definition at line 119 of file TrackDepos.cxx.

 {
     if (m_depos.empty()) {
         return false;
     }
     out = m_depos.front();
     m_depos.pop_front();
 
     if (!out) {                 // chirp
         l->debug("EOS at call {}", m_count);
     }
 
     ++m_count;
     return true;
 }

std::vector<track_t> WireCell::Gen::TrackDepos::tracks ( void ) const

inline

Definition at line 41 of file TrackDepos.h.

41 { return m_tracks; }

WireCell::Gen::TrackDepos::m_tracks

std::vector< track_t > m_tracks

Definition: TrackDepos.h:47

Member Data Documentation

Log::logptr_t WireCell::Gen::TrackDepos::l

private

Definition at line 49 of file TrackDepos.h.

double WireCell::Gen::TrackDepos::m_clight

private

Definition at line 45 of file TrackDepos.h.

int WireCell::Gen::TrackDepos::m_count

private

Definition at line 48 of file TrackDepos.h.

std::deque<WireCell::IDepo::pointer> WireCell::Gen::TrackDepos::m_depos

private

Definition at line 46 of file TrackDepos.h.

double WireCell::Gen::TrackDepos::m_stepsize

private

Definition at line 44 of file TrackDepos.h.

std::vector<track_t> WireCell::Gen::TrackDepos::m_tracks

private

Definition at line 47 of file TrackDepos.h.

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

wire-cell-build/gen/inc/WireCellGen/TrackDepos.h
wire-cell-build/gen/src/TrackDepos.cxx

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation