WireCell::IFrameFilter Class Reference
#include <IFrameFilter.h>
Inheritance diagram for WireCell::IFrameFilter:
Collaboration diagram for WireCell::IFrameFilter:
Public Types | |
| typedef std::shared_ptr< IFrameFilter > | pointer |
 Public Types inherited from WireCell::IFunctionNode< IFrame, IFrame > | |
| typedef IFrame | input_type |
| typedef IFrame | output_type |
| typedef std::shared_ptr< const IFrame > | input_pointer |
| typedef std::shared_ptr< const IFrame > | output_pointer |
| typedef IFunctionNode< IFrame, 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 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::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 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
◆ pointer
| typedef std::shared_ptr<IFrameFilter> WireCell::IFrameFilter::pointer |
Definition at line 23 of file IFrameFilter.h.
Constructor & Destructor Documentation
◆ ~IFrameFilter()
|
virtual |
Definition at line 136 of file IfaceDesctructors.cxx.
Member Function Documentation
◆ signature()
|
inlinevirtual |
Set the signature for all subclasses.
Reimplemented from WireCell::IFunctionNode< IFrame, IFrame >.
Definition at line 27 of file IFrameFilter.h.
The documentation for this class was generated from the following files:
- iface/inc/WireCellIface/IFrameFilter.h
- iface/src/IfaceDesctructors.cxx
