WireCell::SigProc::Protodune::StickyCodeMitig Class Reference

#include <Protodune.h>

Inheritance diagram for WireCell::SigProc::Protodune::StickyCodeMitig:

Public Member Functions
	StickyCodeMitig (const std::string &anode_tn="AnodePlane", const std::string &noisedb="OmniChannelNoiseDB", float stky_sig_like_val=15.0, float stky_sig_like_rms=2.0, int stky_max_len=5)
virtual	~StickyCodeMitig ()
virtual WireCell::Waveform::ChannelMaskMap	apply (int channel, signal_t &sig) const
virtual WireCell::Waveform::ChannelMaskMap	apply (channel_signals_t &chansig) const
virtual void	configure (const WireCell::Configuration &config)
	Accept a configuration. More...
virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default configuration. More...
Public Member Functions inherited from WireCell::IChannelFilter
virtual	~IChannelFilter ()
Public Member Functions inherited from WireCell::IComponent< IChannelFilter >
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 ()

Private Attributes
std::string	m_anode_tn
std::string	m_noisedb_tn
IAnodePlane::pointer	m_anode
IChannelNoiseDatabase::pointer	m_noisedb
std::map< int, std::vector< short int > >	m_extra_stky
float	m_stky_sig_like_val
float	m_stky_sig_like_rms
int	m_stky_max_len

Additional Inherited Members
Public Types inherited from WireCell::IChannelFilter
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 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...

Detailed Description

Microboone/ProtoDUNE style noise subtraction.

Fixme: in principle, this class could be general purpose for other detectors. However, it uses the functions above which hard code microboone-isms. If those microboone/protodune-specific parameters can be pulled out to a higher layer then this class can become generic and move outside of this file.

Definition at line 61 of file Protodune.h.

Constructor & Destructor Documentation

Protodune::StickyCodeMitig::StickyCodeMitig	(	const std::string &	anode_tn = "AnodePlane",
		const std::string &	noisedb = "OmniChannelNoiseDB",
		float	stky_sig_like_val = 15.0,
		float	stky_sig_like_rms = 2.0,
		int	stky_max_len = 5
	)

Definition at line 621 of file Protodune.cxx.

    : m_anode_tn(anode)
    , m_noisedb_tn(noisedb)
    , m_stky_sig_like_val(stky_sig_like_val)
    , m_stky_sig_like_rms(stky_sig_like_rms)
    , m_stky_max_len(stky_max_len)

{
}

Protodune::StickyCodeMitig::~StickyCodeMitig ( )

virtual

Definition at line 631 of file Protodune.cxx.

{
}

Member Function Documentation

virtual WireCell::Waveform::ChannelMaskMap WireCell::SigProc::Protodune::StickyCodeMitig::apply ( int  channel, signal_t &  sig  ) const

virtual

Filter in place the signal sig from given channel.

Implements WireCell::IChannelFilter.

virtual WireCell::Waveform::ChannelMaskMap WireCell::SigProc::Protodune::StickyCodeMitig::apply ( channel_signals_t &  chansig ) const

virtual

Filter in place a group of signals together.

Implements WireCell::IChannelFilter.

void Protodune::StickyCodeMitig::configure ( const WireCell::Configuration &  config )

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 635 of file Protodune.cxx.

{
    m_anode_tn = get(cfg, "anode", m_anode_tn);
    m_anode = Factory::find_tn<IAnodePlane>(m_anode_tn);
    if (!m_anode) {
        THROW(KeyError() << errmsg{"failed to get IAnodePlane: " + m_anode_tn});
    }

    m_noisedb_tn = get(cfg, "noisedb", m_noisedb_tn);
    m_noisedb = Factory::find_tn<IChannelNoiseDatabase>(m_noisedb_tn);

    m_extra_stky.clear();
    auto jext = cfg["extra_stky"];
    if(!jext.isNull()){
        for(auto jone: jext) {
            auto jchans = jone["channels"];
            for (auto jchan: jchans){
                int channel = jchan.asInt();
                // std::cerr << "[wgu] ch# " << channel << " has " << jone["bits"].size() << " extra stky bits:" << std::endl;
                for(auto bit: jone["bits"]){
                    // std::cerr << "[wgu] " << bit.asInt() << std::endl;
                    m_extra_stky[channel].push_back((short int)bit.asInt());
                }                
            }

        }
    }

    if (cfg.isMember("stky_sig_like_val")){
        m_stky_sig_like_val = get(cfg, "stky_sig_like_val", m_stky_sig_like_val);
    }

    if (cfg.isMember("stky_sig_like_rms")){
        m_stky_sig_like_rms = get(cfg, "stky_sig_like_rms", m_stky_sig_like_rms);
    }    

    if (cfg.isMember("stky_max_len")){
        m_stky_max_len = get(cfg, "stky_max_len", m_stky_max_len);
    }
}

WireCell::Configuration Protodune::StickyCodeMitig::default_configuration ( ) const

virtual

Optional, override to return a hard-coded default configuration.

Reimplemented from WireCell::IConfigurable.

Definition at line 675 of file Protodune.cxx.

{
    Configuration cfg;
    cfg["anode"] = m_anode_tn;
    cfg["noisedb"] = m_noisedb_tn;
    cfg["stky_sig_like_val"] = m_stky_sig_like_val;
    cfg["stky_sig_like_rms"] = m_stky_sig_like_rms;
    cfg["stky_max_len"] = m_stky_max_len;    
    return cfg;
}

Member Data Documentation

IAnodePlane::pointer WireCell::SigProc::Protodune::StickyCodeMitig::m_anode

private

Definition at line 85 of file Protodune.h.

std::string WireCell::SigProc::Protodune::StickyCodeMitig::m_anode_tn

private

Definition at line 84 of file Protodune.h.

std::map<int, std::vector<short int> > WireCell::SigProc::Protodune::StickyCodeMitig::m_extra_stky

private

Definition at line 88 of file Protodune.h.

IChannelNoiseDatabase::pointer WireCell::SigProc::Protodune::StickyCodeMitig::m_noisedb

private

Definition at line 86 of file Protodune.h.

std::string WireCell::SigProc::Protodune::StickyCodeMitig::m_noisedb_tn

private

Definition at line 84 of file Protodune.h.

int WireCell::SigProc::Protodune::StickyCodeMitig::m_stky_max_len

private

Definition at line 91 of file Protodune.h.

float WireCell::SigProc::Protodune::StickyCodeMitig::m_stky_sig_like_rms

private

Definition at line 90 of file Protodune.h.

float WireCell::SigProc::Protodune::StickyCodeMitig::m_stky_sig_like_val

private

Definition at line 89 of file Protodune.h.

---

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

• wire-cell-build/sigproc/inc/WireCellSigProc/Protodune.h
• wire-cell-build/sigproc/src/Protodune.cxx