WireCell::Gen::SilentNoise Class Reference

#include <SilentNoise.h>

Inheritance diagram for WireCell::Gen::SilentNoise:

Public Member Functions
	SilentNoise ()
virtual	~SilentNoise ()
virtual void	configure (const WireCell::Configuration &config)
	Accept a configuration. More...
virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default configuration. More...
virtual bool	operator() (output_pointer &out)
	The calling signature: More...
Public Member Functions inherited from WireCell::IFrameSource
virtual	~IFrameSource ()
Public Member Functions inherited from WireCell::ISourceNode< IFrame >
virtual	~ISourceNode ()
virtual NodeCategory	category ()
	Return the behavior category type. More...
virtual std::string	signature ()
	Set the signature for all subclasses. 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
int	m_count
int	m_noutputs
int	m_nchannels
std::string	m_traces_tag

Additional Inherited Members
Public Types inherited from WireCell::IFrameSource
typedef std::shared_ptr< IFrameSource >	pointer
Public Types inherited from WireCell::ISourceNode< IFrame >
typedef IFrame	output_type
typedef ISourceNode< IFrame >	signature_type
typedef std::shared_ptr< signature_type >	pointer
typedef std::shared_ptr< const IFrame >	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

A source of "noise" which has no noise. It's used just as an trivial example which real noise models may copy. Although it inherits from IConfigurable, it's not really. Again, just giving an example.

Definition at line 14 of file SilentNoise.h.

Constructor & Destructor Documentation

Gen::SilentNoise::SilentNoise

(

)

Definition at line 16 of file SilentNoise.cxx.

    : m_count(0)
{
}

Gen::SilentNoise::~SilentNoise ( )

virtual

Definition at line 21 of file SilentNoise.cxx.

{
}

Member Function Documentation

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

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 25 of file SilentNoise.cxx.

{
    m_noutputs = get(cfg,"noutputs",0);
    m_nchannels = get(cfg,"nchannels",0);
    m_traces_tag = cfg["traces_tag"].asString();
}

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

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 32 of file SilentNoise.cxx.

{
    Configuration cfg;
    cfg["noutputs"] = 0;        // run forever
    cfg["nchannels"] = 0;       // empty
    cfg["traces_tag"] = "";     // empty string means no tag on traces
    return cfg;
}

bool Gen::SilentNoise::operator() ( output_pointer &  out )

virtual

The calling signature:

Implements WireCell::ISourceNode< IFrame >.

Definition at line 42 of file SilentNoise.cxx.

{
    out = nullptr;
    if (m_noutputs and m_count == m_noutputs) {
        ++m_count;
        return true;
    }
    if (m_noutputs and m_count >= m_noutputs) {
        return false;
    }
    //std::cerr << "SilentNoise: output #" << m_count << " / " << m_noutputs << std::endl;
    ITrace::vector traces(m_nchannels);
    for (int ind=0; ind<m_nchannels; ++ind) {
        traces[ind] = std::make_shared<SimpleTrace>(ind, 0, 0); // boring traces
    }
    auto sfout = new SimpleFrame(m_count, m_count*5.0*units::ms, traces);
    if (m_traces_tag != "") {
        IFrame::trace_list_t tl(m_nchannels);
        std::iota(tl.begin(), tl.end(), 0);
        sfout->tag_traces(m_traces_tag, tl);
    }
    out = IFrame::pointer(sfout);
    ++m_count;
    return true;
}

Member Data Documentation

int WireCell::Gen::SilentNoise::m_count

private

Definition at line 28 of file SilentNoise.h.

int WireCell::Gen::SilentNoise::m_nchannels

private

Definition at line 29 of file SilentNoise.h.

int WireCell::Gen::SilentNoise::m_noutputs

private

Definition at line 29 of file SilentNoise.h.

std::string WireCell::Gen::SilentNoise::m_traces_tag

private

Definition at line 30 of file SilentNoise.h.

---

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

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