Public Types | Public Member Functions | List of all members
WireCell::IFrameFilter Class Reference

#include <IFrameFilter.h>

Inheritance diagram for WireCell::IFrameFilter:
WireCell::IFunctionNode< IFrame, IFrame > WireCell::IFunctionNodeBase WireCell::INode WireCell::IComponent< INode > WireCell::Interface wcls::FrameSaver WireCell::Gen::AddNoise WireCell::Gen::Digitizer WireCell::Gen::Misconfigure WireCell::Gen::PerChannelVariation WireCell::Gen::Reframer WireCell::Gen::Retagger WireCell::Root::CelltreeFrameSink WireCell::Root::MagnifySink WireCell::Root::RootfileCreation_frames WireCell::SigProc::ChannelSelector WireCell::SigProc::L1SPFilter WireCell::SigProc::OmnibusNoiseFilter WireCell::SigProc::OmnibusPMTNoiseFilter WireCell::SigProc::OmnibusSigProc WireCell::Sio::NumpyFrameSaver

Public Types

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

virtual ~IFrameFilter ()
 
virtual std::string signature ()
 Set the signature for all subclasses. More...
 
- Public Member Functions inherited from WireCell::IFunctionNode< IFrame, 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::stringinput_types ()
 
virtual std::vector< std::stringoutput_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 filter is something that applies some transformation on its input frame to produce and output frame. This is a functional node so does no buffering. The unit of the sample of the output frame may differ from input.

Note, if the output frame samples are conceptually integral they are nonetheless still stored as floating point values. Consumers of the output frame should take care of rounding and truncating as required.

Definition at line 20 of file IFrameFilter.h.

Member Typedef Documentation

Definition at line 23 of file IFrameFilter.h.

Constructor & Destructor Documentation

IFrameFilter::~IFrameFilter ( )
virtual

Definition at line 136 of file IfaceDesctructors.cxx.

136 {}

Member Function Documentation

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

Set the signature for all subclasses.

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

Definition at line 27 of file IFrameFilter.h.

27  {
28  return typeid(IFrameFilter).name();
29  }
static QCString name
Definition: declinfo.cpp:673

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