WireCell::Gen::AddNoise Class Reference

#include <AddNoise.h>

Inheritance diagram for WireCell::Gen::AddNoise:

Public Member Functions
	AddNoise (const std::string &model="", const std::string &rng="Random")
virtual	~AddNoise ()
virtual bool	operator() (const input_pointer &inframe, output_pointer &outframe)
	IFrameFilter. More...
virtual void	configure (const WireCell::Configuration &config)
	IConfigurable. More...
virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default 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
IRandom::pointer	m_rng
IChannelSpectrum::pointer	m_model
std::string	m_model_tn
std::string	m_rng_tn
int	m_nsamples
double	m_rep_percent
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 AddNoise.h.

Constructor & Destructor Documentation

Gen::AddNoise::AddNoise	(	const std::string &	model = "",
		const std::string &	rng = "Random"
	)

Definition at line 19 of file AddNoise.cxx.

    : m_model_tn(model)
    , m_rng_tn(rng)
    , m_nsamples(9600)
    , m_rep_percent(0.02) // replace 2% at a time
    , log(Log::logger("sim"))
{
}

Gen::AddNoise::~AddNoise ( )

virtual

Definition at line 29 of file AddNoise.cxx.

{
}

Member Function Documentation

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

virtual

IConfigurable.

Implements WireCell::IConfigurable.

Definition at line 46 of file AddNoise.cxx.

{
    m_rng_tn = get(cfg, "rng", m_rng_tn);
    m_rng = Factory::find_tn<IRandom>(m_rng_tn);
    m_model_tn = get(cfg, "model", m_model_tn);
    m_model = Factory::find_tn<IChannelSpectrum>(m_model_tn);
    m_nsamples = get<int>(cfg,"nsamples",m_nsamples);
    m_rep_percent = get<double>(cfg,"replacement_percentage",m_rep_percent);
    
    log->debug("AddNoise: using IRandom: \"{}\", IChannelSpectrum: \"{}\"",
               m_rng_tn, m_model_tn);
}

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

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 33 of file AddNoise.cxx.

{
    Configuration cfg;

    // fixme: maybe add some tag support?

    cfg["model"] = m_model_tn;
    cfg["rng"] = m_rng_tn;
    cfg["nsamples"] = m_nsamples;
    cfg["replacement_percentage"] = m_rep_percent;
    return cfg;
}

bool Gen::AddNoise::operator() ( const input_pointer &  inframe, output_pointer &  outframe  )

virtual

IFrameFilter.

Implements WireCell::IFunctionNode< IFrame, IFrame >.

Definition at line 61 of file AddNoise.cxx.

{
    if (!inframe) {
        outframe = nullptr;
        return true;
    }

    ITrace::vector outtraces;
    for (const auto& intrace : *inframe->traces()) {
        int chid = intrace->channel();
        const auto& spec = (*m_model)(chid);
        Waveform::realseq_t wave = Gen::Noise::generate_waveform(spec, m_rng, m_rep_percent);

        wave.resize(m_nsamples,0);
        Waveform::increase(wave, intrace->charge());
        auto trace = make_shared<SimpleTrace>(chid, intrace->tbin(), wave);
        outtraces.push_back(trace);
    }
    outframe = make_shared<SimpleFrame>(inframe->ident(), inframe->time(),
                                        outtraces, inframe->tick());
    return true;
}

Member Data Documentation

Log::logptr_t WireCell::Gen::AddNoise::log

private

Definition at line 44 of file AddNoise.h.

IChannelSpectrum::pointer WireCell::Gen::AddNoise::m_model

private

Definition at line 38 of file AddNoise.h.

std::string WireCell::Gen::AddNoise::m_model_tn

private

Definition at line 40 of file AddNoise.h.

int WireCell::Gen::AddNoise::m_nsamples

private

Definition at line 41 of file AddNoise.h.

double WireCell::Gen::AddNoise::m_rep_percent

private

Definition at line 42 of file AddNoise.h.

IRandom::pointer WireCell::Gen::AddNoise::m_rng

private

Definition at line 37 of file AddNoise.h.

std::string WireCell::Gen::AddNoise::m_rng_tn

private

Definition at line 40 of file AddNoise.h.

---

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

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