WireCell::Gen::PerChannelVariation Class Reference

#include <PerChannelVariation.h>

Inheritance diagram for WireCell::Gen::PerChannelVariation:

Public Member Functions
	PerChannelVariation ()
virtual	~PerChannelVariation ()
virtual bool	operator() (const input_pointer &in, output_pointer &out)
	The calling signature: More...
virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default configuration. More...
virtual void	configure (const WireCell::Configuration &cfg)
	Accept a configuration. More...
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
std::string	m_per_chan_resp
WireCell::IChannelResponse::pointer	m_cr
int	m_nsamples
WireCell::Waveform::realseq_t	m_from
bool	m_truncate

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 32 of file PerChannelVariation.h.

Constructor & Destructor Documentation

Gen::PerChannelVariation::PerChannelVariation

(

)

Definition at line 15 of file PerChannelVariation.cxx.

{
}

Gen::PerChannelVariation::~PerChannelVariation ( )

virtual

Definition at line 19 of file PerChannelVariation.cxx.

{
}

Member Function Documentation

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

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 52 of file PerChannelVariation.cxx.

{
    m_per_chan_resp = get<std::string>(cfg, "per_chan_resp", "");

    if (! m_per_chan_resp.empty()) {
        std::cerr<<"SIMULATION: CH-BY-CH ELECTRONICS RESPONSE VARIATION\n";
        m_cr = Factory::find_tn<IChannelResponse>(m_per_chan_resp);
        double tick = cfg["tick"].asDouble();
        auto cr_bins = m_cr->channel_response_binning();
        if (cr_bins.binsize() != tick) {
            THROW(ValueError() << errmsg{"PerChannelVariation: channel response tbin size mismatch!"});
        }
        m_nsamples = cr_bins.nbins();
        WireCell::Binning tbins(m_nsamples, cr_bins.min(), cr_bins.min() + m_nsamples*tick);
        m_from = Response::ColdElec(cfg["gain"].asDouble(), 
                                    cfg["shaping"].asDouble()).generate(tbins);
    }

    m_truncate = cfg["truncate"].asBool();
}

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

virtual

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

If to truncate the waveforms. The convolution used to apply the misconfiguring will extend the a trace's waveform by nsamples-1. Truncating will clip that much off so the waveform will remains the same length but some information may be lost. If not truncated, this longer waveform likely needs to be handled in some way by the user.

ch-by-ch electronics responses by calibration

Reimplemented from WireCell::IConfigurable.

Definition at line 24 of file PerChannelVariation.cxx.

{
    Configuration cfg;

    // nominally correctly configured amplifiers in MB.  They should
    // match what ever was used to create the input waveforms.
    cfg["gain"] = 14.0*units::mV/units::fC;
    cfg["shaping"] = 2.2*units::us;
 
    // The number of nsamples of the response functions.
    cfg ["nsamples"] = 310;
    // The period of sampling the response functions
    cfg["tick"] = 0.5*units::us;
 
    /// If to truncate the waveforms.  The convolution
    /// used to apply the misconfiguring will extend the a trace's
    /// waveform by nsamples-1.  Truncating will clip that much off so
    /// the waveform will remains the same length but some information
    /// may be lost.  If not truncated, this longer waveform likely
    /// needs to be handled in some way by the user.  
    cfg["truncate"] = true;

    /// ch-by-ch electronics responses by calibration
    cfg["per_chan_resp"] = "";
   
    return cfg;
}

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

virtual

The calling signature:

Implements WireCell::IFunctionNode< IFrame, IFrame >.

Definition at line 73 of file PerChannelVariation.cxx.

{
    if (!in) {
        out = nullptr;
        return true;
    }
    
    if (m_per_chan_resp.empty()) {
        std::cerr << "Gen::PerChannelVariation: warning no ch-by-ch response was found!\n";
        out = in;
        return true;
    }

    auto traces = in->traces();
    if (!traces) {
        std::cerr << "Gen::PerChannelVariation: error no traces in frame for me\n";
        return false;
    }


    size_t ntraces = traces->size();
    ITrace::vector out_traces(ntraces);
    for (size_t ind=0; ind<ntraces; ++ind) {
        auto trace = traces->at(ind);
        auto chid = trace->channel();
        Waveform::realseq_t tch_resp = m_cr->channel_response(chid);
        tch_resp.resize(m_nsamples, 0);
        auto wave = Waveform::replace_convolve(trace->charge(),
                                               tch_resp, m_from, m_truncate);
        out_traces[ind] = std::make_shared<SimpleTrace>(chid, trace->tbin(), wave);
    }

    out = std::make_shared<SimpleFrame>(in->ident(), in->time(), out_traces, in->tick());
    return true;
}

Member Data Documentation

WireCell::IChannelResponse::pointer WireCell::Gen::PerChannelVariation::m_cr

private

Definition at line 46 of file PerChannelVariation.h.

WireCell::Waveform::realseq_t WireCell::Gen::PerChannelVariation::m_from

private

Definition at line 48 of file PerChannelVariation.h.

int WireCell::Gen::PerChannelVariation::m_nsamples

private

Definition at line 47 of file PerChannelVariation.h.

std::string WireCell::Gen::PerChannelVariation::m_per_chan_resp

private

Definition at line 45 of file PerChannelVariation.h.

bool WireCell::Gen::PerChannelVariation::m_truncate

private

Definition at line 49 of file PerChannelVariation.h.

---

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

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