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

#include <IFrameSlicer.h>

Inheritance diagram for WireCell::IFrameSlicer:
Collaboration diagram for WireCell::IFrameSlicer:

Public Types

typedef std::shared_ptr< IFrameSlicerpointer
 
- Public Types inherited from WireCell::IFunctionNode< IFrame, ISliceFrame >
typedef IFrame input_type
 
typedef ISliceFrame output_type
 
typedef std::shared_ptr< const IFrameinput_pointer
 
typedef std::shared_ptr< const ISliceFrameoutput_pointer
 
typedef IFunctionNode< IFrame, ISliceFramesignature_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 Member Functions

virtual ~IFrameSlicer ()
 
virtual std::string signature ()
 Set the signature for all subclasses. More...
 
- Public Member Functions inherited from WireCell::IFunctionNode< IFrame, ISliceFrame >
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 ()
 

Detailed Description

A frame slicer conceptually performs a transpose of a frame from being tick-major order to being channel-major while on the way possibly rebinning the per-tick samples by applying some metric function (typically just a sum) and possibly some uncertainty function.

Note, there could be a closely related IQueuedoutNode which instead returns a queue of ISlice which might be more suited to stream processing. OTOH, implementations of this IFrameSlicer are expected produce an ISliceFrame which spans the same time as the input IFrame.

Definition at line 23 of file IFrameSlicer.h.

Member Typedef Documentation

◆ pointer

Definition at line 26 of file IFrameSlicer.h.

Constructor & Destructor Documentation

◆ ~IFrameSlicer()

IFrameSlicer::~IFrameSlicer ( )
virtual

Definition at line 139 of file IfaceDesctructors.cxx.

Member Function Documentation

◆ signature()

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

Set the signature for all subclasses.

Reimplemented from WireCell::IFunctionNode< IFrame, ISliceFrame >.

Definition at line 30 of file IFrameSlicer.h.


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