#include <Misconfigure.h>

Inheritance diagram for WireCell::Gen::Misconfigure:

Public Member Functions
	Misconfigure ()

virtual	~Misconfigure ()

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
Waveform::realseq_t	m_from

Waveform::realseq_t	m_to

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 33 of file Misconfigure.h.

Constructor & Destructor Documentation

Gen::Misconfigure::Misconfigure ( )

Definition at line 13 of file Misconfigure.cxx.

14 {

15 }

Gen::Misconfigure::~Misconfigure ( )

virtual

Definition at line 17 of file Misconfigure.cxx.

18 {

19 }

Member Function Documentation

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

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 53 of file Misconfigure.cxx.

 {
     int n = cfg["nsamples"].asInt();
     double tick = cfg["tick"].asDouble();
     Binning bins(n, 0, n*tick);
 
     m_from = Response::ColdElec(cfg["from"]["gain"].asDouble(),
                                 cfg["from"]["shaping"].asDouble()).generate(bins);
     m_to   = Response::ColdElec(cfg["to"]["gain"].asDouble(),
                                 cfg["to"]["shaping"].asDouble()).generate(bins);
 
     m_truncate = cfg["truncate"].asBool();
 }

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

virtual

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

The number of samples of the response functions.

The period of sampling the response functions

If to truncate the misconfigured 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.

Reimplemented from WireCell::IConfigurable.

Definition at line 22 of file Misconfigure.cxx.

 {
     Configuration cfg;
 
     // nominally correctly configured amplifiers in MB.  They should
     // match what ever was used to create the input waveforms.
     cfg["from"]["gain"] = 14.0*units::mV/units::fC;
     cfg["from"]["shaping"] = 2.2*units::us;
 
     // Nominally misconfigured amplifiers in MB.  They should match
     // whatever you wished the input waveforms would have been created
     // with.
     cfg["to"]["gain"] = 4.7*units::mV/units::fC;
     cfg["to"]["shaping"] = 1.1*units::us;
 
     /// The number of samples of the response functions.
     cfg["nsamples"] = 50;
     /// The period of sampling the response functions
     cfg["tick"] = 0.5*units::us;
 
     /// If to truncate the misconfigured 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;
 
     return cfg;
 }

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

virtual

The calling signature:

Implements WireCell::IFunctionNode< IFrame, IFrame >.

Definition at line 67 of file Misconfigure.cxx.

 {
     out = nullptr;
     if (!in) {
         return true;            // eos, but we don't care here.
     }
 
     auto traces = in->traces();
     if (!traces) {
         std::cerr << "Gen::Misconfigure: warning no traces in frame for me\n";
         return true;
     }
 
     size_t ntraces = traces->size();
     ITrace::vector out_traces(ntraces);
     for (size_t ind=0; ind<ntraces; ++ind) {
         auto trace = traces->at(ind);
 
         auto wave = Waveform::replace_convolve(trace->charge(),
                                                m_to, m_from, m_truncate);
         out_traces[ind] = std::make_shared<SimpleTrace>(trace->channel(), trace->tbin(), wave);
     }
 
     out = std::make_shared<SimpleFrame>(in->ident(), in->time(), out_traces, in->tick());
     return true;
 }

Member Data Documentation

Waveform::realseq_t WireCell::Gen::Misconfigure::m_from

private

Definition at line 46 of file Misconfigure.h.

Waveform::realseq_t WireCell::Gen::Misconfigure::m_to

private

Definition at line 46 of file Misconfigure.h.

bool WireCell::Gen::Misconfigure::m_truncate

private

Definition at line 47 of file Misconfigure.h.

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation