WireCell::SigProc::NominalChannelResponse Class Reference

#include <NominalChannelResponse.h>

Inheritance diagram for WireCell::SigProc::NominalChannelResponse:

Public Member Functions
	NominalChannelResponse (double gain=14 *WireCell::units::mV/WireCell::units::fC, double shaping=2 *WireCell::units::us, const Binning &binning=Binning(100, 0, 10 *WireCell::units::us))
virtual	~NominalChannelResponse ()
virtual const Waveform::realseq_t &	channel_response (int channel_ident) const
virtual Binning	channel_response_binning () const
	Return the binning that the channel_response follows. More...
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::IChannelResponse
virtual	~IChannelResponse ()
Public Member Functions inherited from WireCell::IComponent< IChannelResponse >
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
double	m_gain
double	m_shaping
Binning	m_bins
Waveform::realseq_t	m_cr

Additional Inherited Members
Public Types inherited from WireCell::IComponent< IChannelResponse >
typedef std::shared_ptr< IChannelResponse >	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 14 of file NominalChannelResponse.h.

Constructor & Destructor Documentation

SigProc::NominalChannelResponse::NominalChannelResponse	(	double	gain = 14*WireCell::units::mV/WireCell::units::fC,
		double	shaping = 2*WireCell::units::us,
		const Binning &	binning = Binning(100, 0, 10*WireCell::units::us)
	)

Definition at line 12 of file NominalChannelResponse.cxx.

    : m_gain(gain)
    , m_shaping(shaping)
    , m_bins(binning)
{
}

SigProc::NominalChannelResponse::~NominalChannelResponse ( )

virtual

Definition at line 21 of file NominalChannelResponse.cxx.

{
}

Member Function Documentation

const Waveform::realseq_t & SigProc::NominalChannelResponse::channel_response ( int  channel_ident ) const

virtual

Provide the channel response for the given channel ID number. Note the binning of the returned waveform should be coordinated through configuration.

Implements WireCell::IChannelResponse.

Definition at line 52 of file NominalChannelResponse.cxx.

{
    return m_cr;
}

Binning SigProc::NominalChannelResponse::channel_response_binning ( ) const

virtual

Return the binning that the channel_response follows.

Implements WireCell::IChannelResponse.

Definition at line 57 of file NominalChannelResponse.cxx.

{
    return m_bins;
}

void SigProc::NominalChannelResponse::configure ( const WireCell::Configuration &  config )

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 36 of file NominalChannelResponse.cxx.

{
    m_gain = get(cfg,"gain",m_gain);
    m_shaping = get(cfg,"shaping",m_shaping);
    int nbins = get(cfg,"nbins", m_bins.nbins());
    double tmin = get(cfg,"tmin",m_bins.min());
    double tmax = get(cfg,"tmax",m_bins.max());
    Response::ColdElec ce(m_gain, m_shaping);
    m_bins = Binning(nbins, tmin, tmax);
    m_cr = ce.generate(m_bins);
    if (m_cr.empty()) {
        THROW(ValueError() << errmsg{"Failed to generate any nominal channel response"});
    }
}

WireCell::Configuration SigProc::NominalChannelResponse::default_configuration ( ) const

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 25 of file NominalChannelResponse.cxx.

{
    Configuration cfg;
    cfg["gain"] = m_gain;
    cfg["shaping"] = m_shaping;
    cfg["nbins"] = m_bins.nbins();
    cfg["tmin"] = m_bins.min();
    cfg["tmax"] = m_bins.max();
    return cfg;
}

Member Data Documentation

Binning WireCell::SigProc::NominalChannelResponse::m_bins

private

Definition at line 32 of file NominalChannelResponse.h.

Waveform::realseq_t WireCell::SigProc::NominalChannelResponse::m_cr

private

Definition at line 34 of file NominalChannelResponse.h.

double WireCell::SigProc::NominalChannelResponse::m_gain

private

Definition at line 31 of file NominalChannelResponse.h.

double WireCell::SigProc::NominalChannelResponse::m_shaping

private

Definition at line 31 of file NominalChannelResponse.h.

---

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

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