WireCell::Gen::BlipSource Class Reference

#include <BlipSource.h>

Inheritance diagram for WireCell::Gen::BlipSource:

Classes
struct	PointMaker
struct	ScalarMaker

Public Member Functions
	BlipSource ()
virtual	~BlipSource ()
virtual bool	operator() (IDepo::pointer &depo)
	IDepoSource. More...
virtual void	configure (const WireCell::Configuration &cfg)
	IConfigurable. More...
virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default configuration. More...
Public Member Functions inherited from WireCell::IDepoSource
virtual	~IDepoSource ()
virtual std::string	signature ()
	Set the signature for all subclasses. More...
Public Member Functions inherited from WireCell::ISourceNode< IDepo >
virtual	~ISourceNode ()
virtual NodeCategory	category ()
	Return the behavior category type. More...
virtual bool	operator() (boost::any &anyout)
virtual std::vector< std::string >	output_types ()
Public Member Functions inherited from WireCell::ISourceNodeBase
virtual	~ISourceNodeBase ()
Public Member Functions inherited from WireCell::INode
virtual	~INode ()
virtual int	concurrency ()
virtual std::vector< std::string >	input_types ()
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_rng_tn
IRandom::pointer	m_rng
double	m_time
double	m_stop
ScalarMaker *	m_ene
ScalarMaker *	m_tim
PointMaker *	m_pos
int	m_blip_count
bool	m_eos

Additional Inherited Members
Public Types inherited from WireCell::IDepoSource
typedef std::shared_ptr< IDepoSource >	pointer
Public Types inherited from WireCell::ISourceNode< IDepo >
typedef IDepo	output_type
typedef ISourceNode< IDepo >	signature_type
typedef std::shared_ptr< signature_type >	pointer
typedef std::shared_ptr< const IDepo >	output_pointer
Public Types inherited from WireCell::ISourceNodeBase
typedef std::shared_ptr< ISourceNodeBase >	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 16 of file BlipSource.h.

Constructor & Destructor Documentation

Gen::BlipSource::BlipSource

(

)

Definition at line 14 of file BlipSource.cxx.

    : m_rng_tn("Random")
    , m_time(0.0)
    , m_ene(nullptr)
    , m_tim(nullptr)
    , m_pos(nullptr)
    , m_blip_count(0)
    , m_eos(false)
{
}

Gen::BlipSource::~BlipSource ( )

virtual

Definition at line 25 of file BlipSource.cxx.

{
    delete m_ene; m_ene = nullptr;
    delete m_tim; m_tim = nullptr;
    delete m_pos; m_pos = nullptr;
}

Member Function Documentation

void Gen::BlipSource::configure ( const WireCell::Configuration &  cfg )

virtual

IConfigurable.

Implements WireCell::IConfigurable.

Definition at line 128 of file BlipSource.cxx.

{
    m_rng_tn = get(cfg, "rng", m_rng_tn);
    m_rng = Factory::find_tn<IRandom>(m_rng_tn);

    auto ene = cfg["charge"];
    if (ene["type"].asString() == "mono") {
        m_ene = new ReturnValue(ene["value"].asDouble());
    }
    else if (ene["type"].asString() == "pdf") {
        m_ene = new Pdf(m_rng, get< std::vector<double> >(ene, "pdf"), get< std::vector<double> >(ene, "edges"));
    }
    else {
        std::cerr <<"BlipSource: no charge configuration\n";
        THROW(ValueError() << errmsg{"BlipSource: no charge configuration"});
    }

    auto tim = cfg["time"];
    m_time = tim["start"].asDouble();
    m_stop = tim["stop"].asDouble();
    if (tim["type"].asString() == "decay") {
        m_tim = new DecayTime(m_rng, tim["activity"].asDouble());
    }
    else {
        std::cerr <<"BlipSource: no time configuration\n";
        THROW(ValueError() << errmsg{"BlipSource: no time configuration"});
    }

    auto pos = cfg["position"];
    if (pos["type"].asString() == "box") {
        Ray box = WireCell::convert<Ray>(pos["extent"]);
        std::cerr << "Box: \n\t" << box.first/units::mm << "mm\n\t" << box.second/units::mm << "mm\n";
        m_pos = new UniformBox(m_rng, box);
    }
    else {
        std::cerr <<"BlipSource: no position configuration\n";
        THROW(ValueError() << errmsg{"BlipSource: no position configuration"});
    }
}

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

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 34 of file BlipSource.cxx.

{
    Configuration cfg;
    cfg["rng"] = "Random";

    Configuration ene;
    ene["type"] = "mono";       // future: spectrum, uniform, Ar39 
    ene["value"] = 20000.0;
    cfg["charge"] = ene;
    // also, in Jsonnet can support PDFs giving probability for certain number of electrons
    // { type="pdf",
    //   edges=[(0.1+b*0.1)*wc.MeV for b in std.range(0,10)], // energy edges
    //   pdf=[my_pdf_function(self.edges)]}


    Configuration tim;
    tim["type"] = "decay";
    tim["start"] = 0.0;
    tim["stop"] = 10.0*units::ms;
    tim["activity"] = 100000*units::Bq; // Ar39 in 2 DUNE drift volumes
    cfg["time"] = tim;

    Configuration pos;
    pos["type"] = "box";
    Configuration tail, head, extent;
    tail["x"] = -1*units::m; tail["y"] = -1*units::m; tail["z"] = -1*units::m;
    head["x"] = +1*units::m; head["y"] = +1*units::m; head["z"] = +1*units::m;
    extent["tail"] = tail; extent["head"] = head;
    pos["extent"] = extent;

    cfg["position"] = pos;

    return cfg;
        
}

bool Gen::BlipSource::operator() ( IDepo::pointer &  depo )

virtual

IDepoSource.

Implements WireCell::ISourceNode< IDepo >.

Definition at line 168 of file BlipSource.cxx.

{
    if (m_eos) {
        return false;
    }

    m_time += (*m_tim)();
    if (m_time > m_stop) {
        std::cerr <<"BlipSource: reached stop time: "
                  << m_time/units::ms << " > " << m_stop/units::ms << std::endl;
        depo = nullptr;
        m_eos = true;
        return true;
    }
    ++m_blip_count;
    depo = std::make_shared<SimpleDepo>(m_time, (*m_pos)(), (*m_ene)(),
                                        nullptr, 0, 0, m_blip_count);
    return true;
}

Member Data Documentation

int WireCell::Gen::BlipSource::m_blip_count

private

Definition at line 46 of file BlipSource.h.

ScalarMaker* WireCell::Gen::BlipSource::m_ene

private

Definition at line 44 of file BlipSource.h.

bool WireCell::Gen::BlipSource::m_eos

private

Definition at line 47 of file BlipSource.h.

PointMaker* WireCell::Gen::BlipSource::m_pos

private

Definition at line 45 of file BlipSource.h.

IRandom::pointer WireCell::Gen::BlipSource::m_rng

private

Definition at line 41 of file BlipSource.h.

std::string WireCell::Gen::BlipSource::m_rng_tn

private

Definition at line 40 of file BlipSource.h.

double WireCell::Gen::BlipSource::m_stop

private

Definition at line 43 of file BlipSource.h.

ScalarMaker * WireCell::Gen::BlipSource::m_tim

private

Definition at line 44 of file BlipSource.h.

double WireCell::Gen::BlipSource::m_time

private

Definition at line 43 of file BlipSource.h.

---

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

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