WireCell::Gen::FrameFanout Class Reference

#include <FrameFanout.h>

Inheritance diagram for WireCell::Gen::FrameFanout:

Public Member Functions
	FrameFanout (size_t multiplicity=0)
virtual	~FrameFanout ()
virtual std::vector< std::string >	output_types ()
virtual bool	operator() (const input_pointer &in, output_vector &outv)
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...
Public Member Functions inherited from WireCell::IFrameFanout
virtual	~IFrameFanout ()
virtual std::string	signature ()
Public Member Functions inherited from WireCell::IFanoutNode< IFrame, IFrame, 0 >
virtual	~IFanoutNode ()
virtual bool	operator() (const boost::any &anyin, any_vector &anyv)
	The calling signature: More...
virtual std::vector< std::string >	input_types ()
Public Member Functions inherited from WireCell::IFanoutNodeBase
virtual	~IFanoutNodeBase ()
virtual NodeCategory	category ()
	Return the behavior category type. More...
virtual int	concurrency ()
	Fanout nodes can usually do their thing 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
size_t	m_multiplicity
tagrules::Context	m_ft
Log::logptr_t	log

Additional Inherited Members
Public Types inherited from WireCell::IFanoutNode< IFrame, IFrame, 0 >
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 std::vector< output_pointer >	output_vector
Public Types inherited from WireCell::IFanoutNodeBase
typedef std::shared_ptr< IFanoutNodeBase >	pointer
typedef std::vector< boost::any >	any_vector
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 13 of file FrameFanout.h.

Constructor & Destructor Documentation

Gen::FrameFanout::FrameFanout

(

size_t

multiplicity = 0

)

Definition at line 13 of file FrameFanout.cxx.

    : m_multiplicity(multiplicity)
    , log(Log::logger("glue"))
{
}

Gen::FrameFanout::~FrameFanout ( )

virtual

Definition at line 18 of file FrameFanout.cxx.

{
}

Member Function Documentation

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

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 35 of file FrameFanout.cxx.

{
    int m = get<int>(cfg, "multiplicity", (int)m_multiplicity);
    if (m<=0) {
        THROW(ValueError() << errmsg{"FrameFanout multiplicity must be positive"});
    }
    m_multiplicity = m;

    m_ft.configure(cfg["tag_rules"]);
}

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

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 22 of file FrameFanout.cxx.

{
    Configuration cfg;
    // How many output ports
    cfg["multiplicity"] = (int)m_multiplicity;
    // Tag rules are an array, one element per output port.  Each
    // element is an object keyed with "frame" or "trace".  Each of
    // their values are an object keyed by a regular expression
    // (regex) and with values that are a single tag or an array of
    // tags.  See util/test_tagrules for examples.
    cfg["tag_rules"] = Json::arrayValue;
    return cfg;
}

bool Gen::FrameFanout::operator() ( const input_pointer &  in, output_vector &  outv  )

virtual

Implements WireCell::IFanoutNode< IFrame, IFrame, 0 >.

Definition at line 55 of file FrameFanout.cxx.

{
    outv.resize(m_multiplicity);

    if (!in) {                  //  pass on EOS
        for (size_t ind=0; ind<m_multiplicity; ++ind) {
            outv[ind] = in;
        }
        log->debug("FrameFanout: see EOS");
        return true;
    }

    auto fintags = in->frame_tags();
    // Add empty tag to allow rules to create an output tag even if none exist.
    // No equivalent should be made for trace tags.
    fintags.push_back("");


    std::stringstream taginfo;

    for (size_t ind=0; ind<m_multiplicity; ++ind) {

        // Basic frame stays the same.
        auto sfout = new SimpleFrame(in->ident(), in->time(), *in->traces(), in->tick());

        // Transform any frame tags based on a per output port ruleset
        auto fouttags = m_ft.transform(ind, "frame", fintags);

        for (auto ftag : fouttags) {
            sfout->tag_frame(ftag);
            taginfo << " ftag:" << ftag;
        }

        for (auto inttag : in->trace_tags()) {
            tagrules::tagset_t touttags = m_ft.transform(ind, "trace", inttag);
            if (touttags.empty()) {
                continue;
            }
            const auto& traces = in->tagged_traces(inttag);
            const auto& summary = in->trace_summary(inttag);
            for (auto otag : touttags) {
                sfout->tag_traces(otag, traces, summary);
                taginfo << " " << inttag << "->" << otag;
            }
        };

        outv[ind] = IFrame::pointer(sfout);
    }

    std::string tagmsg = taginfo.str();
    if (!tagmsg.empty()) {
        log->debug("FrameFanout: tagnifo:{}", taginfo.str());
    }
    return true;
}

std::vector< std::string > Gen::FrameFanout::output_types ( )

virtual

Implements WireCell::IFrameFanout.

Definition at line 47 of file FrameFanout.cxx.

{
    const std::string tname = std::string(typeid(output_type).name());
    std::vector<std::string> ret(m_multiplicity, tname);
    return ret;
}

Member Data Documentation

Log::logptr_t WireCell::Gen::FrameFanout::log

private

Definition at line 32 of file FrameFanout.h.

tagrules::Context WireCell::Gen::FrameFanout::m_ft

private

Definition at line 31 of file FrameFanout.h.

size_t WireCell::Gen::FrameFanout::m_multiplicity

private

Definition at line 29 of file FrameFanout.h.

---

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

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