WireCell::Gen::StaticChannelStatus Class Reference

#include <StaticChannelStatus.h>

Inheritance diagram for WireCell::Gen::StaticChannelStatus:

Classes
struct	ChannelStatus

Public Types
typedef std::unordered_map< int, ChannelStatus >	channel_status_map_t
Public Types inherited from WireCell::IComponent< IChannelStatus >
typedef std::shared_ptr< IChannelStatus >	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
	StaticChannelStatus (double nominal_gain=14.0 *units::mV/units::fC, double nominal_shaping=2.0 *units::us, channel_status_map_t deviants=channel_status_map_t())
virtual	~StaticChannelStatus ()
virtual double	preamp_gain (int chid) const
virtual double	preamp_shaping (int chid) 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::IChannelStatus
virtual	~IChannelStatus ()
Public Member Functions inherited from WireCell::IComponent< IChannelStatus >
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_nominal_gain
double	m_nominal_shaping
channel_status_map_t	m_deviants

Detailed Description

Definition at line 18 of file StaticChannelStatus.h.

Member Typedef Documentation

typedef std::unordered_map<int, ChannelStatus> WireCell::Gen::StaticChannelStatus::channel_status_map_t

Definition at line 26 of file StaticChannelStatus.h.

Constructor & Destructor Documentation

Gen::StaticChannelStatus::StaticChannelStatus	(	double	nominal_gain = 14.0*units::mV/units::fC,
		double	nominal_shaping = 2.0*units::us,
		channel_status_map_t	deviants = channel_status_map_t()
	)

Definition at line 11 of file StaticChannelStatus.cxx.

    : m_nominal_gain(nominal_gain)
    , m_nominal_shaping(nominal_shaping)
    , m_deviants(deviants)
{
}

Gen::StaticChannelStatus::~StaticChannelStatus ( )

virtual

Definition at line 20 of file StaticChannelStatus.cxx.

{
}

Member Function Documentation

void Gen::StaticChannelStatus::configure ( const WireCell::Configuration &  config )

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 42 of file StaticChannelStatus.cxx.

{
    // let user override any defaults
    m_nominal_gain = get(cfg, "nominal_gain", m_nominal_gain);
    m_nominal_shaping = get(cfg, "nominal_shaping", m_nominal_shaping);

    auto jdev = cfg["deviants"];
    if (jdev.isNull()) {
        return;
    }
    for (auto jone : jdev) {
        const int chid = jone["chid"].asInt(); // must supply
        const double gain = get(jone, "gain", m_nominal_gain);
        const double shaping = get(jone, "shaping", m_nominal_shaping);
        m_deviants[chid] = ChannelStatus(gain, shaping);
    }
}

WireCell::Configuration Gen::StaticChannelStatus::default_configuration ( ) const

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 25 of file StaticChannelStatus.cxx.

{
    Configuration cfg;          // load hard-coded defaults
    cfg["nominal_gain"] = m_nominal_gain;
    cfg["nominal_shaping"] = m_nominal_shaping;
    cfg["deviants"] = Json::arrayValue;
    for (auto it : m_deviants) {
        Json::Value jdev(Json::objectValue);
        jdev["chid"] = it.first;
        jdev["gain"] = it.second.gain;
        jdev["shaping"] = it.second.shaping;
        cfg["deviants"].append(jdev);
    }
    return cfg;
}

double Gen::StaticChannelStatus::preamp_gain ( int  chid ) const

virtual

Return the current gain for the preamplifier in units of [voltage]/[charge].

Implements WireCell::IChannelStatus.

Definition at line 62 of file StaticChannelStatus.cxx.

{
    auto it = m_deviants.find(chid);
    if (it == m_deviants.end()) {
        return m_nominal_gain;
    }
    return it->second.gain;
}

double Gen::StaticChannelStatus::preamp_shaping ( int  chid ) const

virtual

Return the current shaping time of the preamplifier for the given channel in units of [time].

Implements WireCell::IChannelStatus.

Definition at line 70 of file StaticChannelStatus.cxx.

{
    auto it = m_deviants.find(chid);
    if (it == m_deviants.end()) {
        return m_nominal_shaping;
    }
    return it->second.shaping;
}

Member Data Documentation

channel_status_map_t WireCell::Gen::StaticChannelStatus::m_deviants

private

Definition at line 43 of file StaticChannelStatus.h.

double WireCell::Gen::StaticChannelStatus::m_nominal_gain

private

Definition at line 42 of file StaticChannelStatus.h.

double WireCell::Gen::StaticChannelStatus::m_nominal_shaping

private

Definition at line 42 of file StaticChannelStatus.h.

---

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

• wire-cell-build/gen/inc/WireCellGen/StaticChannelStatus.h
• wire-cell-build/gen/src/StaticChannelStatus.cxx