WireCellToolkit
Wire Cell Simulation, Signal Process and Reconstruction Toolki for Liquid Argon Detectors
WireCell::Gen::DepoFramer Class Reference

#include <DepoFramer.h>

Inheritance diagram for WireCell::Gen::DepoFramer:
Collaboration 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)
 
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 bool operator() (const input_pointer &in, output_pointer &out)=0
 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 ()
 

Additional Inherited Members

- Public Types inherited from WireCell::IFunctionNode< IDepoSet, IFrame >
typedef IDepoSet input_type
 
typedef IFrame output_type
 
typedef std::shared_ptr< const IDepoSetinput_pointer
 
typedef std::shared_ptr< const IFrameoutput_pointer
 
typedef IFunctionNode< IDepoSet, IFramesignature_type
 
- Public Types inherited from WireCell::IFunctionNodeBase
typedef std::shared_ptr< IFunctionNodeBasepointer
 
- 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< INodepointer
 Access subclass facet by pointer. More...
 
typedef std::vector< pointervector
 Vector of shared pointers. More...
 
- Public Types inherited from WireCell::Interface
typedef std::shared_ptr< Interfacepointer
 
- Public Types inherited from WireCell::IComponent< IConfigurable >
typedef std::shared_ptr< IConfigurablepointer
 Access subclass facet by pointer. More...
 
typedef std::vector< pointervector
 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

◆ DepoFramer()

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

Definition at line 12 of file DepoFramer.cxx.

◆ ~DepoFramer()

Gen::DepoFramer::~DepoFramer ( )
virtual

Definition at line 18 of file DepoFramer.cxx.

Member Function Documentation

◆ configure()

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

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 31 of file DepoFramer.cxx.

◆ default_configuration()

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.

Here is the call graph for this function:

◆ operator()()

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

Definition at line 39 of file DepoFramer.cxx.

Here is the call graph for this function:

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