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

#include <IDuctor.h>

Inheritance diagram for WireCell::IDuctor:
Collaboration diagram for WireCell::IDuctor:

Public Types

typedef std::shared_ptr< IDuctorpointer
 
- Public Types inherited from WireCell::IQueuedoutNode< IDepo, IFrame >
typedef std::shared_ptr< IQueuedoutNodeBasepointer
 
typedef IDepo input_type
 
typedef IFrame output_type
 
typedef std::shared_ptr< const IDepoinput_pointer
 
typedef std::shared_ptr< const IFrameoutput_pointer
 
typedef std::deque< output_pointeroutput_queue
 
- Public Types inherited from WireCell::IQueuedoutNodeBase
typedef std::shared_ptr< IQueuedoutNodeBasepointer
 
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< 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 Member Functions

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 bool operator() (const input_pointer &in, output_queue &outq)=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::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 ()
 

Detailed Description

A ductor consumes depositions and collects the response on electrodes due to the depos drifting past as a number of sampled waveforms. This interface does not specify the units of the samples and they are left up to the implementation. But, they are typically either current or charge if only electric field responses are applied or voltage if additionally an electronics response model is applied.

Implementation may also apply digitization in which case the floating point samples should be considered integer. Digitization may also be implemented as an IFrameFilter.

Definition at line 22 of file IDuctor.h.

Member Typedef Documentation

◆ pointer

typedef std::shared_ptr<IDuctor> WireCell::IDuctor::pointer

Definition at line 25 of file IDuctor.h.

Constructor & Destructor Documentation

◆ ~IDuctor()

IDuctor::~IDuctor ( )
virtual

Definition at line 128 of file IfaceDesctructors.cxx.

Member Function Documentation

◆ signature()

virtual std::string WireCell::IDuctor::signature ( )
inlinevirtual

The signature is string unique to all classes that implement a particular calling signature. These should be defined in lower level interfaces such as a mythical IMyFooToBarConverter.

Implements WireCell::INode.

Definition at line 29 of file IDuctor.h.


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