WireCell::IChannelFilter Class Reference

#include <IChannelFilter.h>

Inheritance diagram for WireCell::IChannelFilter:

Public Types
typedef Waveform::realseq_t	signal_t
typedef std::map< int, signal_t >	channel_signals_t
Public Types inherited from WireCell::IComponent< IChannelFilter >
typedef std::shared_ptr< IChannelFilter >	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	~IChannelFilter ()
virtual Waveform::ChannelMaskMap	apply (int channel, signal_t &sig) const =0
virtual Waveform::ChannelMaskMap	apply (channel_signals_t &chansig) const =0
Public Member Functions inherited from WireCell::IComponent< IChannelFilter >
virtual	~IComponent ()
Public Member Functions inherited from WireCell::Interface
virtual	~Interface ()

Detailed Description

A channel filter mutates digitized waveforms from channels.

Definition at line 14 of file IChannelFilter.h.

Member Typedef Documentation

typedef std::map<int, signal_t> WireCell::IChannelFilter::channel_signals_t

Definition at line 20 of file IChannelFilter.h.

typedef Waveform::realseq_t WireCell::IChannelFilter::signal_t

Definition at line 19 of file IChannelFilter.h.

Constructor & Destructor Documentation

IChannelFilter::~IChannelFilter ( )

virtual

Definition at line 101 of file IfaceDesctructors.cxx.

{}

Member Function Documentation

virtual Waveform::ChannelMaskMap WireCell::IChannelFilter::apply ( int  channel, signal_t &  sig  ) const

pure virtual

Filter in place the signal sig from given channel. Return a channel mask map with any tick-level masking that may be applied later.

Implemented in WireCell::SigProc::Microboone::ADCBitShift, WireCell::SigProc::Protodune::RelGainCalib, WireCell::SigProc::Microboone::OneChannelStatus, WireCell::SigProc::Microboone::OneChannelNoise, WireCell::SigProc::Protodune::OneChannelNoise, WireCell::SigProc::Microboone::CoherentNoiseSub, and WireCell::SigProc::Protodune::StickyCodeMitig.

virtual Waveform::ChannelMaskMap WireCell::IChannelFilter::apply ( channel_signals_t &  chansig ) const

pure virtual

Filter in place a group of signals together. Return a channel mask map with any tick-level masking that may be applied later.

Implemented in WireCell::SigProc::Microboone::ADCBitShift, WireCell::SigProc::Protodune::RelGainCalib, WireCell::SigProc::Microboone::OneChannelStatus, WireCell::SigProc::Microboone::OneChannelNoise, WireCell::SigProc::Protodune::OneChannelNoise, WireCell::SigProc::Microboone::CoherentNoiseSub, and WireCell::SigProc::Protodune::StickyCodeMitig.

---

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

• wire-cell-build/iface/inc/WireCellIface/IChannelFilter.h
• wire-cell-build/iface/src/IfaceDesctructors.cxx