WireCell::Gen::DepoTransform Class Reference

#include <DepoTransform.h>

Inheritance diagram for WireCell::Gen::DepoTransform:

Public Member Functions
	DepoTransform ()
virtual	~DepoTransform ()
virtual bool	operator() (const input_pointer &in, output_pointer &out)
	The calling signature: More...
virtual void	configure (const WireCell::Configuration &cfg)
	Accept a configuration. More...
virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default configuration. More...
virtual IDepo::pointer	modify_depo (WirePlaneId wpid, IDepo::pointer depo)
Public Member Functions inherited from WireCell::IDepoFramer
virtual	~IDepoFramer ()
virtual std::string	signature ()
	Set the signature for all subclasses. More...
Public Member Functions inherited from WireCell::IFunctionNode< IDepoSet, 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
IRandom::pointer	m_rng
std::vector< IPlaneImpactResponse::pointer >	m_pirs
double	m_start_time
double	m_readout_time
double	m_tick
double	m_drift_speed
double	m_nsigma
int	m_frame_count
Log::logptr_t	l

Additional Inherited Members
Public Types inherited from WireCell::IFunctionNode< IDepoSet, IFrame >
typedef IDepoSet	input_type
typedef IFrame	output_type
typedef std::shared_ptr< const IDepoSet >	input_pointer
typedef std::shared_ptr< const IFrame >	output_pointer
typedef IFunctionNode< IDepoSet, 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 19 of file DepoTransform.h.

Constructor & Destructor Documentation

Gen::DepoTransform::DepoTransform

(

)

Definition at line 57 of file DepoTransform.cxx.

    : m_start_time(0.0*units::ns)
    , m_readout_time(5.0*units::ms)
    , m_tick(0.5*units::us)
    , m_drift_speed(1.0*units::mm/units::us)
    , m_nsigma(3.0)
    , m_frame_count(0)
    , l(Log::logger("sim"))
{
}

Gen::DepoTransform::~DepoTransform ( )

virtual

Definition at line 68 of file DepoTransform.cxx.

{
}

Member Function Documentation

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

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 72 of file DepoTransform.cxx.

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

    m_nsigma = get<double>(cfg, "nsigma", m_nsigma);
    bool fluctuate = get<bool>(cfg, "fluctuate", false);
    m_rng = nullptr;
    if (fluctuate) {
        auto rng_tn = get<string>(cfg, "rng", "");
        m_rng = Factory::find_tn<IRandom>(rng_tn);
    }

    m_readout_time = get<double>(cfg, "readout_time", m_readout_time);
    m_tick = get<double>(cfg, "tick", m_tick);
    m_start_time = get<double>(cfg, "start_time", m_start_time);
    m_drift_speed = get<double>(cfg, "drift_speed", m_drift_speed);
    m_frame_count = get<int>(cfg, "first_frame_number", m_frame_count);

    auto jpirs = cfg["pirs"];
    if (jpirs.isNull() or jpirs.empty()) {
        std::string msg = "must configure with some plane impact response components";
        l->error(msg);
        THROW(ValueError() << errmsg{"Gen::Ductor: " + msg});
    }
    m_pirs.clear();
    for (auto jpir : jpirs) {
        auto tn = jpir.asString();
        auto pir = Factory::find_tn<IPlaneImpactResponse>(tn);
        m_pirs.push_back(pir);
    }

}

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

virtual

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

How many Gaussian sigma due to diffusion to keep before truncating.

Whether to fluctuate the final Gaussian deposition.

The open a gate. This is actually a "readin" time measured at the input ("reference") plane.

The time span for each readout. This is actually a "readin" time span measured at the input ("reference") plane.

The sample period

The nominal speed of drifting electrons

Allow for a custom starting frame number

Name of component providing the anode plane.

Name of component providing the anode pseudo random number generator.

Plane impact responses

Reimplemented from WireCell::IConfigurable.

Definition at line 105 of file DepoTransform.cxx.

{
    Configuration cfg;


    /// How many Gaussian sigma due to diffusion to keep before truncating.
    put(cfg, "nsigma", m_nsigma);

    /// Whether to fluctuate the final Gaussian deposition.
    put(cfg, "fluctuate", false);

    /// The open a gate.  This is actually a "readin" time measured at
    /// the input ("reference") plane.
    put(cfg, "start_time", m_start_time);

    /// The time span for each readout.  This is actually a "readin"
    /// time span measured at the input ("reference") plane.
    put(cfg, "readout_time", m_readout_time);

    /// The sample period
    put(cfg, "tick", m_tick);

    /// The nominal speed of drifting electrons
    put(cfg, "drift_speed", m_drift_speed);

    /// Allow for a custom starting frame number
    put(cfg, "first_frame_number", m_frame_count);

    /// Name of component providing the anode plane.
    put(cfg, "anode", "");
    /// Name of component providing the anode pseudo random number generator.
    put(cfg, "rng", "");

    /// Plane impact responses
    cfg["pirs"] = Json::arrayValue;


    return cfg;
}

virtual IDepo::pointer WireCell::Gen::DepoTransform::modify_depo ( WirePlaneId  wpid, IDepo::pointer  depo  )

inlinevirtual

dummy depo modifier used for the application of the charge scaling bases on dQdx calibration see the detailed implementation in larwirecell or uboonecode

Definition at line 34 of file DepoTransform.h.

                                                                                 {
                return depo;
            }

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

virtual

The calling signature:

Implements WireCell::IFunctionNode< IDepoSet, IFrame >.

Definition at line 145 of file DepoTransform.cxx.

{
    if (!in) {
        out = nullptr;
        return true;
    }

    auto depos = in->depos();

    Binning tbins(m_readout_time/m_tick, m_start_time, m_start_time+m_readout_time);
    ITrace::vector traces;
    for (auto face : m_anode->faces()) {

        // Select the depos which are in this face's sensitive volume
        IDepo::vector face_depos, dropped_depos;
        auto bb = face->sensitive();
        if (bb.empty()) {
            l->debug("anode {} face {} is marked insensitive, skipping",
                     m_anode->ident(), face->ident());
            continue;
        }

        for (auto depo : (*depos)) {
            if (bb.inside(depo->pos())) {
                face_depos.push_back(depo);
            }
            else {
                dropped_depos.push_back(depo);
            }
        }

        if (face_depos.size()) {
            auto ray = bb.bounds();
            l->debug("anode: {}, face: {}, processing {} depos spanning "
                     "t:[{},{}]ms, bb:[{}-->{}]cm",
                     m_anode->ident(), face->ident(), face_depos.size(),
                     face_depos.front()->time()/units::ms,
                     face_depos.back()->time()/units::ms,
                     ray.first/units::cm,ray.second/units::cm);
        }
        if (dropped_depos.size()) {
            auto ray = bb.bounds();
            l->debug("anode: {}, face: {}, dropped {} depos spanning "
                     "t:[{},{}]ms, outside bb:[{}-->{}]cm",
                     m_anode->ident(), face->ident(),
                     dropped_depos.size(),
                     dropped_depos.front()->time()/units::ms,
                     dropped_depos.back()->time()/units::ms,
                     ray.first/units::cm, ray.second/units::cm);

        }

        int iplane = -1;
        for (auto plane : face->planes()) {
            ++iplane;

            const Pimpos* pimpos = plane->pimpos();

            Binning tbins(m_readout_time/m_tick, m_start_time,
                          m_start_time+m_readout_time);

            Gen::BinnedDiffusion_transform bindiff(*pimpos, tbins, m_nsigma, m_rng);
            for (auto depo : face_depos) {
                depo = modify_depo(plane->planeid(), depo);
                bindiff.add(depo, depo->extent_long() / m_drift_speed, depo->extent_tran());
            }

            auto& wires = plane->wires();

            auto pir = m_pirs.at(iplane);
            Gen::ImpactTransform transform(pir, bindiff);

            const int nwires = pimpos->region_binning().nbins();
            for (int iwire=0; iwire<nwires; ++iwire) {
                auto wave = transform.waveform(iwire);
                
                auto mm = Waveform::edge(wave);
                if (mm.first == (int)wave.size()) { // all zero
                    continue;
                }
                
                int chid = wires[iwire]->channel();
                int tbin = mm.first;

                ITrace::ChargeSequence charge(wave.begin()+mm.first, wave.begin()+mm.second);
                auto trace = make_shared<SimpleTrace>(chid, tbin, charge);
                traces.push_back(trace);
            }
        }
    }

    auto frame = make_shared<SimpleFrame>(m_frame_count, m_start_time, traces, m_tick);
    ++m_frame_count;
    out = frame;
    return true;
}

Member Data Documentation

Log::logptr_t WireCell::Gen::DepoTransform::l

private

Definition at line 50 of file DepoTransform.h.

IAnodePlane::pointer WireCell::Gen::DepoTransform::m_anode

private

Definition at line 40 of file DepoTransform.h.

double WireCell::Gen::DepoTransform::m_drift_speed

private

Definition at line 47 of file DepoTransform.h.

int WireCell::Gen::DepoTransform::m_frame_count

private

Definition at line 49 of file DepoTransform.h.

double WireCell::Gen::DepoTransform::m_nsigma

private

Definition at line 48 of file DepoTransform.h.

std::vector<IPlaneImpactResponse::pointer> WireCell::Gen::DepoTransform::m_pirs

private

Definition at line 42 of file DepoTransform.h.

double WireCell::Gen::DepoTransform::m_readout_time

private

Definition at line 45 of file DepoTransform.h.

IRandom::pointer WireCell::Gen::DepoTransform::m_rng

private

Definition at line 41 of file DepoTransform.h.

double WireCell::Gen::DepoTransform::m_start_time

private

Definition at line 44 of file DepoTransform.h.

double WireCell::Gen::DepoTransform::m_tick

private

Definition at line 46 of file DepoTransform.h.

---

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

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