WireCell::SigProc::Protodune::RelGainCalib Class Reference

#include <Protodune.h>

Inheritance diagram for WireCell::SigProc::Protodune::RelGainCalib:

Public Member Functions
	RelGainCalib (const std::string &anode_tn="AnodePlane", const std::string &noisedb="OmniChannelNoiseDB", float gain_def=1.0, float gain_min_cut=0.8, float gain_max_cut=1.25)
virtual	~RelGainCalib ()
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
float	m_gain_def
float	m_gain_min_cut
float	m_gain_max_cut
std::vector< float >	m_rel_gain

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

Definition at line 120 of file Protodune.h.

Constructor & Destructor Documentation

Protodune::RelGainCalib::RelGainCalib	(	const std::string &	anode_tn = "AnodePlane",
		const std::string &	noisedb = "OmniChannelNoiseDB",
		float	gain_def = 1.0,
		float	gain_min_cut = 0.8,
		float	gain_max_cut = 1.25
	)

Definition at line 1034 of file Protodune.cxx.

    : m_anode_tn(anode)
    , m_noisedb_tn(noisedb)
    , m_gain_def(gain_def)
    , m_gain_min_cut(gain_min_cut)
    , m_gain_max_cut(gain_max_cut)
{
}

Protodune::RelGainCalib::~RelGainCalib ( )

virtual

Definition at line 1043 of file Protodune.cxx.

{
}

Member Function Documentation

virtual WireCell::Waveform::ChannelMaskMap WireCell::SigProc::Protodune::RelGainCalib::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::RelGainCalib::apply ( channel_signals_t &  chansig ) const

virtual

Filter in place a group of signals together.

Implements WireCell::IChannelFilter.

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

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 1047 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);

    if (cfg.isMember("gain_def")) {
        m_gain_def = get(cfg, "gain_def", m_gain_def);
    }

    if (cfg.isMember("gain_min_cut")){
        m_gain_min_cut = get(cfg, "gain_min_cut", m_gain_min_cut);
    }

    if (cfg.isMember("gain_max_cut")){
        m_gain_max_cut = get(cfg, "gain_max_cut", m_gain_max_cut);
    }
    
    m_rel_gain.clear();
    for (auto jch : cfg["rel_gain"]) {
        m_rel_gain.push_back(jch.asDouble());
    }

}

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

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 1076 of file Protodune.cxx.

{
    Configuration cfg;
    cfg["anode"] = m_anode_tn;
    cfg["noisedb"] = m_noisedb_tn;
    cfg["gain_def"] = m_gain_def;
    cfg["gain_min_cut"] = m_gain_min_cut;
    cfg["gain_max_cut"] = m_gain_max_cut;   
    return cfg;
}

Member Data Documentation

IAnodePlane::pointer WireCell::SigProc::Protodune::RelGainCalib::m_anode

private

Definition at line 144 of file Protodune.h.

std::string WireCell::SigProc::Protodune::RelGainCalib::m_anode_tn

private

Definition at line 143 of file Protodune.h.

float WireCell::SigProc::Protodune::RelGainCalib::m_gain_def

private

Definition at line 147 of file Protodune.h.

float WireCell::SigProc::Protodune::RelGainCalib::m_gain_max_cut

private

Definition at line 149 of file Protodune.h.

float WireCell::SigProc::Protodune::RelGainCalib::m_gain_min_cut

private

Definition at line 148 of file Protodune.h.

IChannelNoiseDatabase::pointer WireCell::SigProc::Protodune::RelGainCalib::m_noisedb

private

Definition at line 145 of file Protodune.h.

std::string WireCell::SigProc::Protodune::RelGainCalib::m_noisedb_tn

private

Definition at line 143 of file Protodune.h.

std::vector<float> WireCell::SigProc::Protodune::RelGainCalib::m_rel_gain

private

Definition at line 151 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