WireCell::Gen::DepoFramer Class Reference

#include <DepoFramer.h>

Inheritance diagram for WireCell::Gen::DepoFramer:

Public Member Functions
	DepoFramer (const std::string &drifter="Drifter", const std::string &ductor="Ductor")
virtual	~DepoFramer ()
virtual bool	operator() (const input_pointer &in, output_pointer &out)
	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::IDepoFramer
virtual	~IDepoFramer ()
virtual std::string	signature ()
	Set the signature for all subclasses. More...
Public Member Functions inherited from WireCell::IFunctionNode< IDepoSet, IFrame >
virtual	~IFunctionNode ()
virtual bool	operator() (const boost::any &anyin, boost::any &anyout)
	The calling signature: More...
virtual std::vector< std::string >	input_types ()
virtual std::vector< std::string >	output_types ()
Public Member Functions inherited from WireCell::IFunctionNodeBase
virtual	~IFunctionNodeBase ()
virtual NodeCategory	category ()
	Return the behavior category type. More...
virtual int	concurrency ()
	By default assume all subclasses are stateless. 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 ()

Private Attributes
std::string	m_drifter_tn
std::string	m_ductor_tn
IDrifter::pointer	m_drifter
IDuctor::pointer	m_ductor

Additional Inherited Members
Public Types inherited from WireCell::IFunctionNode< IDepoSet, IFrame >
typedef IDepoSet	input_type
typedef IFrame	output_type
typedef std::shared_ptr< const IDepoSet >	input_pointer
typedef std::shared_ptr< const IFrame >	output_pointer
typedef IFunctionNode< IDepoSet, IFrame >	signature_type
Public Types inherited from WireCell::IFunctionNodeBase
typedef std::shared_ptr< IFunctionNodeBase >	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...

Detailed Description

DepoFramer handles simulating the signal from a set of depositions returning a frame of signal voltage traces. The frame ident is taken from the the ident of the input IDepoSet. It delegates to a "drifter" and a "ductor" to perform bulk drifting through the detector volume and conversion of charge distribution to signals via convolution with field and electronics response, respectively.

Because the output frame will span the entire signal corresponding to the sent of input depositions, it is up to the caller to limit this set accordingly.

Definition at line 26 of file DepoFramer.h.

Constructor & Destructor Documentation

Gen::DepoFramer::DepoFramer	(	const std::string &	drifter = "Drifter",
		const std::string &	ductor = "Ductor"
	)

Definition at line 12 of file DepoFramer.cxx.

    : m_drifter_tn(drifter)
    , m_ductor_tn(ductor)
{
}

Gen::DepoFramer::~DepoFramer ( )

virtual

Definition at line 18 of file DepoFramer.cxx.

{
}

Member Function Documentation

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

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 31 of file DepoFramer.cxx.

{
    m_drifter = Factory::find_tn<IDrifter>(get(cfg, "Drifter", m_drifter_tn));
    m_ductor = Factory::find_tn<IDuctor>(get(cfg, "Ductor", m_ductor_tn));

}

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

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 23 of file DepoFramer.cxx.

{
    Configuration cfg;
    put(cfg, "Drifter", m_drifter_tn);
    put(cfg, "Ductor", m_ductor_tn);
    return cfg;
}

bool Gen::DepoFramer::operator() ( const input_pointer &  in, output_pointer &  out  )

virtual

The calling signature:

Implements WireCell::IFunctionNode< IDepoSet, IFrame >.

Definition at line 39 of file DepoFramer.cxx.

{

    const int ident = in->ident();

    // get depos into a mutable vector, sort and terminate
    auto sdepos = in->depos();
    std::vector<IDepo::pointer> depos(sdepos->begin(), sdepos->end()), drifted;
    std::sort(depos.begin(), depos.end(), descending_time);
    depos.push_back(nullptr);

    m_drifter->reset();
    for (auto depo : depos) {
        IDrifter::output_queue dq;
        (*m_drifter)(depo, dq);
        for (auto d : dq) {
            drifted.push_back(d);
        }
    }
    if (drifted.back()) {
        // check if drifter is following protocol
        std::cerr << "Gen::DepoFramer: warning: failed to get null on last drifted depo\n";
        drifted.push_back(nullptr);
    }

    m_ductor->reset();
        
    std::vector<IFrame::pointer> partial_frames;

    for (auto drifted_depo : drifted) {
        IDuctor::output_queue frames;
        (*m_ductor)(drifted_depo, frames);
        for (auto f : frames) {
            partial_frames.push_back(f);
        }
    }

    out = Gen::sum(partial_frames, ident);

    return true;
}

Member Data Documentation

IDrifter::pointer WireCell::Gen::DepoFramer::m_drifter

private

Definition at line 42 of file DepoFramer.h.

std::string WireCell::Gen::DepoFramer::m_drifter_tn

private

Definition at line 41 of file DepoFramer.h.

IDuctor::pointer WireCell::Gen::DepoFramer::m_ductor

private

Definition at line 43 of file DepoFramer.h.

std::string WireCell::Gen::DepoFramer::m_ductor_tn

private

Definition at line 41 of file DepoFramer.h.

---

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

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