WireCell::SigProc::OmnibusNoiseFilter Class Reference
#include <OmnibusNoiseFilter.h>
Inheritance diagram for WireCell::SigProc::OmnibusNoiseFilter:
Collaboration diagram for WireCell::SigProc::OmnibusNoiseFilter:
Public Types | |
| typedef std::vector< std::vector< int > > | grouped_channels_t |
 Public Types inherited from WireCell::IFrameFilter | |
| 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 Types inherited from WireCell::IComponent< IConfigurable > | |
| typedef std::shared_ptr< IConfigurable > | pointer |
| Access subclass facet by pointer. More... | |
| typedef std::vector< pointer > | vector |
| Vector of shared pointers. More... | |
Public Member Functions | |
| OmnibusNoiseFilter (std::string intag="orig", std::string outtag="raw") | |
| Create an OmnibusNoiseFilter. More... | |
| virtual | ~OmnibusNoiseFilter () |
| virtual bool | operator() (const input_pointer &in, output_pointer &out) |
| IFrameFilter interface. More... | |
| virtual void | configure (const WireCell::Configuration &config) |
| IConfigurable interface. More... | |
| virtual WireCell::Configuration | default_configuration () const |
| Optional, override to return a hard-coded default configuration. More... | |
| void | set_channel_filters (std::vector< WireCell::IChannelFilter::pointer > filters) |
| void | set_channel_status_filters (std::vector< WireCell::IChannelFilter::pointer > filters) |
| void | set_grouped_filters (std::vector< WireCell::IChannelFilter::pointer > filters) |
| void | set_channel_noisedb (WireCell::IChannelNoiseDatabase::pointer ndb) |
| Public Member Functions inherited from WireCell::IFrameFilter | |
| 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 () |
| Public Member Functions inherited from WireCell::IConfigurable | |
| virtual | ~IConfigurable () |
| Public Member Functions inherited from WireCell::IComponent< IConfigurable > | |
| virtual | ~IComponent () |
Detailed Description
The Omnibus Noise Filter applies two series of IChannelFilter objects. The first series is applied on a per-channel basis and the second is applied on groups of channels as determined by its channel grouping.
Definition at line 32 of file OmnibusNoiseFilter.h.
Member Typedef Documentation
◆ grouped_channels_t
| typedef std::vector< std::vector<int> > WireCell::SigProc::OmnibusNoiseFilter::grouped_channels_t |
Definition at line 34 of file OmnibusNoiseFilter.h.
Constructor & Destructor Documentation
◆ OmnibusNoiseFilter()
| OmnibusNoiseFilter::OmnibusNoiseFilter | ( | std::string | intag = "orig", |
| std::string | outtag = "raw" |
||
| ) |
Create an OmnibusNoiseFilter.
Definition at line 24 of file OmnibusNoiseFilter.cxx.
◆ ~OmnibusNoiseFilter()
|
virtual |
Definition at line 31 of file OmnibusNoiseFilter.cxx.
Member Function Documentation
◆ configure()
|
virtual |
IConfigurable interface.
Implements WireCell::IConfigurable.
Definition at line 35 of file OmnibusNoiseFilter.cxx.
◆ default_configuration()
|
virtual |
Optional, override to return a hard-coded default configuration.
Reimplemented from WireCell::IConfigurable.
Definition at line 78 of file OmnibusNoiseFilter.cxx.
◆ operator()()
|
virtual |
IFrameFilter interface.
Definition at line 100 of file OmnibusNoiseFilter.cxx.
Here is the call graph for this function:
◆ set_channel_filters()
|
inline |
Definition at line 52 of file OmnibusNoiseFilter.h.
◆ set_channel_noisedb()
|
inline |
Definition at line 61 of file OmnibusNoiseFilter.h.
◆ set_channel_status_filters()
|
inline |
Definition at line 55 of file OmnibusNoiseFilter.h.
◆ set_grouped_filters()
|
inline |
Definition at line 58 of file OmnibusNoiseFilter.h.
The documentation for this class was generated from the following files:
- sigproc/inc/WireCellSigProc/OmnibusNoiseFilter.h
- sigproc/src/OmnibusNoiseFilter.cxx
