#include <Ductor.h>

Inheritance diagram for WireCell::Gen::Ductor:

Public Member Functions
	Ductor ()

virtual	~Ductor ()

virtual bool	operator() (const input_pointer &depo, output_queue &frames)
	The calling signature: More...

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...

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

virtual std::string	signature ()

Public Member Functions inherited from WireCell::IQueuedoutNode< IDepo, IFrame >
virtual	~IQueuedoutNode ()

virtual bool	operator() (const boost::any &anyin, queuedany &outanyq)
	The calling signature: More...

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

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

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

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

virtual int	concurrency ()
	By default assume all subclasses maintain state. More...

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

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 ()

Protected Member Functions
virtual void	process (output_queue &frames)

virtual ITrace::vector	process_face (IAnodeFace::pointer face, const IDepo::vector &face_depos)

bool	start_processing (const input_pointer &depo)

Protected Attributes
std::string	m_anode_tn

std::string	m_rng_tn

std::vector< std::string >	m_pir_tns

IAnodePlane::pointer	m_anode

IRandom::pointer	m_rng

std::vector< IPlaneImpactResponse::pointer >	m_pirs

IDepo::vector	m_depos

double	m_start_time

double	m_readout_time

double	m_tick

double	m_drift_speed

double	m_nsigma

bool	m_fluctuate

std::string	m_mode

int	m_frame_count

Log::logptr_t	l

Additional Inherited Members
Public Types inherited from WireCell::IDuctor
typedef std::shared_ptr< IDuctor >	pointer

Public Types inherited from WireCell::IQueuedoutNode< IDepo, IFrame >
typedef std::shared_ptr< IQueuedoutNodeBase >	pointer

typedef IDepo	input_type

typedef IFrame	output_type

typedef std::shared_ptr< const IDepo >	input_pointer

typedef std::shared_ptr< const IFrame >	output_pointer

typedef std::deque< output_pointer >	output_queue

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

typedef std::deque< boost::any >	queuedany

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...

Detailed Description

This IDuctor needs a Garfield2D field calculation data file in compressed JSON format as produced by Python module wirecell.sigproc.garfield.

Definition at line 25 of file Ductor.h.

Constructor & Destructor Documentation

Gen::Ductor::Ductor ( )

Definition at line 19 of file Ductor.cxx.

     : m_anode_tn("AnodePlane")
     , m_rng_tn("Random")
     , m_start_time(0.0*units::ns)
     , m_readout_time(5.0*units::ms)
     , m_tick(0.5*units::us)
     , m_drift_speed(1.0*units::mm/units::us)
     , m_nsigma(3.0)
     , m_fluctuate(true)
     , m_mode("continuous")
     , m_frame_count(0)
     , l(Log::logger("sim"))
 {
 }

virtual WireCell::Gen::Ductor::~Ductor ( )

inlinevirtual

Definition at line 29 of file Ductor.h.

29 {};

Member Function Documentation

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

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 84 of file Ductor.cxx.

 {
     m_anode_tn = get<string>(cfg, "anode", m_anode_tn);
     m_anode = Factory::find_tn<IAnodePlane>(m_anode_tn);
 
     m_nsigma = get<double>(cfg, "nsigma", m_nsigma);
     bool continuous = get<bool>(cfg, "continuous", true);
     bool fixed = get<bool>(cfg, "fixed", false);
 
     m_mode = "continuous";
     if (fixed) {
         m_mode = "fixed";
     }
     else if (!continuous) {
         m_mode = "discontinuous";
     }
 
     m_fluctuate = get<bool>(cfg, "fluctuate", m_fluctuate);
     m_rng = nullptr;
     if (m_fluctuate) {
         m_rng_tn = get(cfg, "rng", m_rng_tn);
         m_rng = Factory::find_tn<IRandom>(m_rng_tn);
     }
 
     m_readout_time = get<double>(cfg, "readout_time", m_readout_time);
     m_tick = get<double>(cfg, "tick", m_tick);
     m_start_time = get<double>(cfg, "start_time", m_start_time);
     m_drift_speed = get<double>(cfg, "drift_speed", m_drift_speed);
     m_frame_count = get<int>(cfg, "first_frame_number", m_frame_count);
 
     auto jpirs = cfg["pirs"];
     if (jpirs.isNull() or jpirs.empty()) {
         l->critical("must configure with some plane impace response components");
         THROW(ValueError() << errmsg{"Gen::Ductor: must configure with some plane impact response components"});
     }
     m_pirs.clear();
     for (auto jpir : jpirs) {
         auto tn = jpir.asString();
         auto pir = Factory::find_tn<IPlaneImpactResponse>(tn);
         m_pirs.push_back(pir);
     }
 
     l->debug("AnodePlane: {}, mode: {}, fluctuate: {}, time start: {} ms, readout time: {} ms, frame start: {}", m_anode_tn, m_mode, (m_fluctuate ? "on" : "off"), m_start_time/units::ms, m_readout_time/units::ms, m_frame_count);
 
 }

WireCell::Configuration Gen::Ductor::default_configuration ( ) const

virtual

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

How many Gaussian sigma due to diffusion to keep before truncating.

Whether to fluctuate the final Gaussian deposition.

The initial time for this ductor

The time span for each readout.

The sample period

If false then determine start time of each readout based on the input depos. This option is useful when running WCT sim on a source of depos which have already been "chunked" in time. If true then this Ductor will continuously simulate all time in "readout_time" frames leading to empty frames in the case of some readout time with no depos.

Fixed mode simply reads out the same time window all the time. It implies discontinuous (continuous == false).

The nominal speed of drifting electrons

Allow for a custom starting frame number

Name of component providing the anode plane.

don't set here so user must, but eg:

Reimplemented from WireCell::IConfigurable.

Definition at line 34 of file Ductor.cxx.

 {
     Configuration cfg;
 
     /// How many Gaussian sigma due to diffusion to keep before truncating.
     put(cfg, "nsigma", m_nsigma);
 
     /// Whether to fluctuate the final Gaussian deposition.
     put(cfg, "fluctuate", m_fluctuate);
 
     /// The initial time for this ductor
     put(cfg, "start_time", m_start_time);
 
     /// The time span for each readout.
     put(cfg, "readout_time", m_readout_time);
 
     /// The sample period
     put(cfg, "tick", m_tick);
 
     /// If false then determine start time of each readout based on the
     /// input depos.  This option is useful when running WCT sim on a
     /// source of depos which have already been "chunked" in time.  If
     /// true then this Ductor will continuously simulate all time in
     /// "readout_time" frames leading to empty frames in the case of
     /// some readout time with no depos.
     put(cfg, "continuous", true);
 
     /// Fixed mode simply reads out the same time window all the time.
     /// It implies discontinuous (continuous == false).
     put(cfg, "fixed", false);
 
     /// The nominal speed of drifting electrons
     put(cfg, "drift_speed", m_drift_speed);
 
     /// Allow for a custom starting frame number
     put(cfg, "first_frame_number", m_frame_count);
 
     /// Name of component providing the anode plane.
     put(cfg, "anode", m_anode_tn);
     put(cfg, "rng", m_rng_tn);
 
     cfg["pirs"] = Json::arrayValue;
     /// don't set here so user must, but eg:
     //cfg["pirs"][0] = "PlaneImpactResponseU";
     //cfg["pirs"][1] = "PlaneImpactResponseV";
     //cfg["pirs"][2] = "PlaneImpactResponseW";
 
     return cfg;
 }

bool Gen::Ductor::operator()	(	const input_pointer &	in,
		output_queue &	outq
	)

virtual

The calling signature:

Implements WireCell::IQueuedoutNode< IDepo, IFrame >.

Definition at line 272 of file Ductor.cxx.

 {
     if (start_processing(depo)) {
         process(frames);
     }
 
     if (depo) {
         m_depos.push_back(depo);
     }
     else {
         frames.push_back(nullptr);
     }
 
     return true;
 }

void Gen::Ductor::process ( output_queue & frames )

protectedvirtual

Definition at line 174 of file Ductor.cxx.

 {
     ITrace::vector traces;
 
     for (auto face : m_anode->faces()) {
 
         // Select the depos which are in this face's sensitive volume
         IDepo::vector face_depos, dropped_depos;
         auto bb = face->sensitive();
         if (bb.empty()) {
             l->debug("anode: {} face: {} is marked insensitive, skipping",
                      m_anode->ident(), face->ident());
             continue;
         }
 
         for (auto depo : m_depos) {
             if (bb.inside(depo->pos())) {
                 face_depos.push_back(depo);
             }
             else {
                 dropped_depos.push_back(depo);
             }
         }
 
         if (face_depos.size()) {
             auto ray = bb.bounds();
             l->debug("anode: {}, face: {}, processing {} depos spanning "
                      "t:[{},{}]ms, bb:[{}-->{}]cm",
                      m_anode->ident(), face->ident(), face_depos.size(),
                      face_depos.front()->time()/units::ms,
                      face_depos.back()->time()/units::ms,
                      ray.first/units::cm,ray.second/units::cm);
         }
         if (dropped_depos.size()) {
             auto ray = bb.bounds();
             l->debug("anode: {}, face: {}, dropped {} depos spanning "
                      "t:[{},{}]ms, outside bb:[{}-->{}]cm",
                      m_anode->ident(), face->ident(),
                      dropped_depos.size(),
                      dropped_depos.front()->time()/units::ms,
                      dropped_depos.back()->time()/units::ms,
                      ray.first/units::cm, ray.second/units::cm);
 
         }
 
         auto newtraces = process_face(face, face_depos);
         traces.insert(traces.end(), newtraces.begin(), newtraces.end());
     }
 
     auto frame = make_shared<SimpleFrame>(m_frame_count, m_start_time, traces, m_tick);
     frames.push_back(frame);
     l->debug("made frame: {} with {} traces @ {}ms",
              m_frame_count, traces.size(), m_start_time/units::ms);
 
     // fixme: what about frame overflow here?  If the depos extend
     // beyond the readout where does their info go?  2nd order,
     // diffusion and finite field response can cause depos near the
     // end of the readout to have some portion of their waveforms
     // lost?
     m_depos.clear();
 
     if (m_mode == "continuous") {
         m_start_time += m_readout_time;
     }
 
     ++m_frame_count;
 }

ITrace::vector Gen::Ductor::process_face	(	IAnodeFace::pointer	face,
		const IDepo::vector &	face_depos
	)

protectedvirtual

Reimplemented in WireCell::Gen::DepoSplat.

Definition at line 130 of file Ductor.cxx.

 {
     ITrace::vector traces;
 
     int iplane = -1;
     for (auto plane : face->planes()) {
         ++iplane;
 
         const Pimpos* pimpos = plane->pimpos();
 
         Binning tbins(m_readout_time/m_tick, m_start_time,
                       m_start_time+m_readout_time);
 
         Gen::BinnedDiffusion bindiff(*pimpos, tbins, m_nsigma, m_rng);
         for (auto depo : face_depos) {
             bindiff.add(depo, depo->extent_long() / m_drift_speed, depo->extent_tran());
         }
 
         auto& wires = plane->wires();
 
         auto pir = m_pirs.at(iplane);
         Gen::ImpactZipper zipper(pir, bindiff);
 
         const int nwires = pimpos->region_binning().nbins();
         for (int iwire=0; iwire<nwires; ++iwire) {
             auto wave = zipper.waveform(iwire);
                 
             auto mm = Waveform::edge(wave);
             if (mm.first == (int)wave.size()) { // all zero
                 continue;
             }
                 
             int chid = wires[iwire]->channel();
             int tbin = mm.first;
 
             ITrace::ChargeSequence charge(wave.begin()+mm.first, wave.begin()+mm.second);
             auto trace = make_shared<SimpleTrace>(chid, tbin, charge);
             traces.push_back(trace);
         }
     }
     return traces;
 }

bool Gen::Ductor::start_processing ( const input_pointer & depo )

protected

Definition at line 244 of file Ductor.cxx.

 {
     if (!depo) {
         return true;
     }
 
     if (m_mode == "fixed") {
         // fixed mode waits until EOS
         return false;
     }
 
     if (m_mode == "discontinuous") {
         // discontinuous mode sets start time on first depo.
         if (m_depos.empty()) {
             m_start_time = depo->time();
             return false;
         }
     }
 
     // continuous and discontinuous modes follow Just Enough
     // Processing(TM) strategy.
 
     // Note: we use this depo time even if it may not actually be
     // inside our sensitive volume.
     bool ok = depo->time() > m_start_time + m_readout_time;
     return ok;
 }

Member Data Documentation

Log::logptr_t WireCell::Gen::Ductor::l

protected

Definition at line 64 of file Ductor.h.

IAnodePlane::pointer WireCell::Gen::Ductor::m_anode

protected

Definition at line 44 of file Ductor.h.

std::string WireCell::Gen::Ductor::m_anode_tn

protected

Definition at line 40 of file Ductor.h.

IDepo::vector WireCell::Gen::Ductor::m_depos

protected

Definition at line 48 of file Ductor.h.

double WireCell::Gen::Ductor::m_drift_speed

protected

Definition at line 53 of file Ductor.h.

bool WireCell::Gen::Ductor::m_fluctuate

protected

Definition at line 55 of file Ductor.h.

int WireCell::Gen::Ductor::m_frame_count

protected

Definition at line 58 of file Ductor.h.

std::string WireCell::Gen::Ductor::m_mode

protected

Definition at line 56 of file Ductor.h.

double WireCell::Gen::Ductor::m_nsigma

protected

Definition at line 54 of file Ductor.h.

std::vector<std::string> WireCell::Gen::Ductor::m_pir_tns

protected

Definition at line 42 of file Ductor.h.

std::vector<IPlaneImpactResponse::pointer> WireCell::Gen::Ductor::m_pirs

protected

Definition at line 46 of file Ductor.h.

double WireCell::Gen::Ductor::m_readout_time

protected

Definition at line 51 of file Ductor.h.

IRandom::pointer WireCell::Gen::Ductor::m_rng

protected

Definition at line 45 of file Ductor.h.

std::string WireCell::Gen::Ductor::m_rng_tn

protected

Definition at line 41 of file Ductor.h.

double WireCell::Gen::Ductor::m_start_time

protected

Definition at line 50 of file Ductor.h.

double WireCell::Gen::Ductor::m_tick

protected

Definition at line 52 of file Ductor.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation