WireCell::Gen::Digitizer Class Reference

#include <Digitizer.h>

Inheritance diagram for WireCell::Gen::Digitizer:

Public Member Functions
	Digitizer (const std::string &anode_tn="AnodePlane", int resolution=12, double gain=-1.0, std::vector< double > fullscale={0.0, 2.0 *units::volt}, std::vector< double > baselines={900 *units::mV, 900 *units::mV, 200 *units::mV})
virtual	~Digitizer ()
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...
virtual bool	operator() (const input_pointer &inframe, output_pointer &outframe)
	The calling signature: More...
double	digitize (double voltage)
Public Member Functions inherited from WireCell::IFrameFilter
virtual	~IFrameFilter ()
virtual std::string	signature ()
	Set the signature for all subclasses. More...
Public Member Functions inherited from WireCell::IFunctionNode< IFrame, IFrame >
virtual	~IFunctionNode ()
virtual bool	operator() (const boost::any &anyin, boost::any &anyout)
	The calling signature: More...
virtual std::vector< std::string >	input_types ()
virtual std::vector< std::string >	output_types ()
Public Member Functions inherited from WireCell::IFunctionNodeBase
virtual	~IFunctionNodeBase ()
virtual NodeCategory	category ()
	Return the behavior category type. More...
virtual int	concurrency ()
	By default assume all subclasses are stateless. More...
Public Member Functions inherited from WireCell::INode
virtual	~INode ()
virtual void	reset ()
Public Member Functions inherited from WireCell::IComponent< INode >
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
IAnodePlane::pointer	m_anode
std::string	m_anode_tn
int	m_resolution
double	m_gain
std::vector< double >	m_fullscale
std::vector< double >	m_baselines
std::string	m_frame_tag
Log::logptr_t	log

Additional Inherited Members
Public Types inherited from WireCell::IFrameFilter
typedef std::shared_ptr< IFrameFilter >	pointer
Public Types inherited from WireCell::IFunctionNode< IFrame, IFrame >
typedef IFrame	input_type
typedef IFrame	output_type
typedef std::shared_ptr< const IFrame >	input_pointer
typedef std::shared_ptr< const IFrame >	output_pointer
typedef IFunctionNode< IFrame, IFrame >	signature_type
Public Types inherited from WireCell::IFunctionNodeBase
typedef std::shared_ptr< IFunctionNodeBase >	pointer
Public Types inherited from WireCell::INode
enum	NodeCategory {   unknown, sourceNode, sinkNode, functionNode,   queuedoutNode, joinNode, splitNode, faninNode,   fanoutNode, multioutNode, hydraNode }
Public Types inherited from WireCell::IComponent< INode >
typedef std::shared_ptr< INode >	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 22 of file Digitizer.h.

Constructor & Destructor Documentation

Gen::Digitizer::Digitizer	(	const std::string &	anode_tn = "AnodePlane",
		int	resolution = 12,
		double	gain = -1.0,
		std::vector< double >	fullscale = {0.0, 2.0*units::volt},
		std::vector< double >	baselines = {900*units::mV,900*units::mV,200*units::mV}
	)

Definition at line 19 of file Digitizer.cxx.

    : m_anode_tn(anode)
    , m_resolution(resolution)
    , m_gain(gain)
    , m_fullscale(fullscale)
    , m_baselines(baselines)
    , m_frame_tag("")
    , log(Log::logger("sim"))
{
}

Gen::Digitizer::~Digitizer ( )

virtual

Definition at line 32 of file Digitizer.cxx.

{
}

Member Function Documentation

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

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 59 of file Digitizer.cxx.

{
    m_anode_tn = get<string>(cfg, "anode", m_anode_tn);
    m_anode = Factory::find_tn<IAnodePlane>(m_anode_tn);

    m_resolution = get(cfg, "resolution", m_resolution);
    m_gain = get(cfg, "gain", m_gain);
    m_fullscale = get(cfg, "fullscale", m_fullscale);
    m_baselines = get(cfg, "baselines", m_baselines);
    m_frame_tag = get(cfg, "frame_tag", m_frame_tag);

    std::stringstream ss;
    ss << "Gen::Digitizer: "
       << "tag=\""<<m_frame_tag << "\", "
       << "resolution="<<m_resolution<<" bits, "
       << "maxvalue=" << (1<<m_resolution) << " counts, "
       << "gain=" << m_gain << ", "
       << "fullscale=[" << m_fullscale[0]/units::mV << "," << m_fullscale[1]/units::mV << "] mV, "
       << "baselines=[" << m_baselines[0]/units::mV << "," << m_baselines[1]/units::mV << "," << m_baselines[2]/units::mV << "] mV";
    log->debug(ss.str());

}

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

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 36 of file Digitizer.cxx.

{
    Configuration cfg;
    put(cfg, "anode", m_anode_tn);

    put(cfg, "resolution", m_resolution);
    put(cfg, "gain", m_gain);
    Configuration fs(Json::arrayValue); // fixme: sure would be nice if we had some templated sugar for this
    for (int ind=0; ind<2; ++ind) {
        fs[ind] = m_fullscale[ind];
    }
    cfg["fullscale"] = fs;

    Configuration bl(Json::arrayValue);
    for (int ind=0; ind<3; ++ind) {
        bl[ind] = m_baselines[ind];
    }
    cfg["baselines"] = bl;

    cfg["frame_tag"] = m_frame_tag;
    return cfg;
}

double Gen::Digitizer::digitize

(

double

voltage

)

Definition at line 83 of file Digitizer.cxx.

{
    const int adcmaxval = (1<<m_resolution)-1;

    if (voltage <= m_fullscale[0]) {
        return 0;
    }
    if (voltage >= m_fullscale[1]) {
        return adcmaxval;
    }
    const double relvoltage = (voltage - m_fullscale[0])/(m_fullscale[1] - m_fullscale[0]);
    return relvoltage*adcmaxval;
}

bool Gen::Digitizer::operator() ( const input_pointer &  in, output_pointer &  out  )

virtual

The calling signature:

Implements WireCell::IFunctionNode< IFrame, IFrame >.

Definition at line 97 of file Digitizer.cxx.

{
    if (!vframe) {              // EOS
        log->debug("Gen::Digitizer: EOS");
        adcframe = nullptr;
        return true;
    }


    // fixme: maybe make this honor a tag 
    auto vtraces = FrameTools::untagged_traces(vframe);
    if (vtraces.empty()) {
        log->error("Gen::Digitizer: no traces in input frame {}", vframe->ident());
        return false;
    }

    // Get extent in channel and tbin
    auto channels = FrameTools::channels(vtraces);
    std::sort(channels.begin(), channels.end());
    auto chbeg = channels.begin();
    auto chend = std::unique(chbeg, channels.end());
    auto tbinmm = FrameTools::tbin_range(vtraces);
    
    const size_t ncols = tbinmm.second-tbinmm.first;
    const size_t nrows = std::distance(chbeg, chend);

    // make a dense array working space.  a row is one trace.  a
    // column is one tick.
    Array::array_xxf arr = Array::array_xxf::Zero(nrows, ncols);
    FrameTools::fill(arr, vtraces, channels.begin(), chend, tbinmm.first);

    ITrace::vector adctraces(nrows);

    for (size_t irow=0; irow < nrows; ++irow) {
        int ch = channels[irow];
        WirePlaneId wpid = m_anode->resolve(ch);
        if (!wpid.valid()) {
            log->warn("Gen::Digitizer, got invalid WPID for channel {}: {}, skipping", ch, wpid);
            continue;
        }
        const float baseline = m_baselines[wpid.index()];

        ITrace::ChargeSequence adcwave(ncols);
        for (size_t icol=0; icol < ncols; ++icol) {
            double voltage = m_gain*arr(irow, icol) + baseline;
            const float adcf = digitize(voltage);
            adcwave[icol] = adcf;
        }
        adctraces[irow] = make_shared<SimpleTrace>(ch, tbinmm.first, adcwave);
    }
    auto sframe = make_shared<SimpleFrame>(vframe->ident(), vframe->time(), adctraces,
                                           vframe->tick(), vframe->masks());
    if (!m_frame_tag.empty()) {
        sframe->tag_frame(m_frame_tag);
    }
    adcframe = sframe;

    return true;
}

Member Data Documentation

Log::logptr_t WireCell::Gen::Digitizer::log

private

Definition at line 50 of file Digitizer.h.

IAnodePlane::pointer WireCell::Gen::Digitizer::m_anode

private

Definition at line 44 of file Digitizer.h.

std::string WireCell::Gen::Digitizer::m_anode_tn

private

Definition at line 45 of file Digitizer.h.

std::vector<double> WireCell::Gen::Digitizer::m_baselines

private

Definition at line 48 of file Digitizer.h.

std::string WireCell::Gen::Digitizer::m_frame_tag

private

Definition at line 49 of file Digitizer.h.

std::vector<double> WireCell::Gen::Digitizer::m_fullscale

private

Definition at line 48 of file Digitizer.h.

double WireCell::Gen::Digitizer::m_gain

private

Definition at line 47 of file Digitizer.h.

int WireCell::Gen::Digitizer::m_resolution

private

Definition at line 46 of file Digitizer.h.

---

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

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