WireCell::SigProc::FrameMerger Class Reference

#include <FrameMerger.h>

Inheritance diagram for WireCell::SigProc::FrameMerger:

Public Member Functions
	FrameMerger ()
virtual	~FrameMerger ()
virtual bool	operator() (const input_tuple_type &intup, output_pointer &out)
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...
Public Member Functions inherited from WireCell::IFrameJoiner
virtual	~IFrameJoiner ()
virtual std::string	signature ()
Public Member Functions inherited from WireCell::IJoinNode< std::tuple< IFrame, IFrame >, IFrame >
virtual	~IJoinNode ()
virtual bool	operator() (const any_vector &anyv, 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::IJoinNodeBase
virtual	~IJoinNodeBase ()
virtual NodeCategory	category ()
	Return the behavior category type. More...
virtual int	concurrency ()
	Join 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
Configuration	m_cfg

Additional Inherited Members
Public Types inherited from WireCell::IFrameJoiner
typedef std::shared_ptr< IFrameJoiner >	pointer
Public Types inherited from WireCell::IJoinNode< std::tuple< IFrame, IFrame >, IFrame >
typedef tuple_helper< std::tuple< IFrame, IFrame > >	port_helper_type
typedef port_helper_type::template WrappedConst< std::shared_ptr >::type	input_tuple_type
typedef tuple_helper< input_tuple_type >	input_helper_type
typedef IFrame	output_type
typedef std::shared_ptr< const IFrame >	output_pointer
Public Types inherited from WireCell::IJoinNodeBase
typedef std::shared_ptr< IJoinNodeBase >	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 14 of file FrameMerger.h.

Constructor & Destructor Documentation

SigProc::FrameMerger::FrameMerger

(

)

Definition at line 150 of file FrameMerger.cxx.

{
}

SigProc::FrameMerger::~FrameMerger ( )

virtual

Definition at line 154 of file FrameMerger.cxx.

{
}

Member Function Documentation

void SigProc::FrameMerger::configure ( const WireCell::Configuration &  config )

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 44 of file FrameMerger.cxx.

{
    m_cfg = cfg;
}

Configuration SigProc::FrameMerger::default_configuration ( ) const

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 15 of file FrameMerger.cxx.

{
    Configuration cfg;

    // The merge map specifies a list of triples of tags.  The first
    // tag in the pair corresponds to a trace tag on the first frame,
    // and likewise the second.  The third is a tag that will be
    // placed on the merged set of traces in the output frame.  The
    // merge is performed considering only traces in the two input
    // frames that respectively match their tags.  As tags may have
    // overlapping sets of traces, it is important to recognize that
    // the merge is progressive and in order of the merge map.  If the
    // merge map is empty then all traces in frame 1 are merged with
    // all traces in frame 2 irrespective of any tags.
    cfg["mergemap"] = Json::arrayValue;

    // The rule determins the algorithm employed in the merge.
    // 
    // - replace :: the last trace encountered for a given channel is output.
    //   The traces from frame 1 will take precedence over any from frame 2.
    //
    // - include :: all traces encountered with a given channel are output.
    //
    // - tbd :: more may be added (eg, sum all traces on a given channel)
    cfg["rule"] = "replace";

    return cfg;
}

bool SigProc::FrameMerger::operator() ( const input_tuple_type &  intup, output_pointer &  out  )

virtual

Implements WireCell::IJoinNode< std::tuple< IFrame, IFrame >, IFrame >.

Definition at line 49 of file FrameMerger.cxx.

{
    out = nullptr;

    auto one = std::get<0>(intup);
    auto two = std::get<1>(intup);
    if (!one or !two) {
        std::cerr << "FrameMerger: EOS\n";
        return true;
    }


    auto jmergemap = m_cfg["mergemap"];
    const int nsets = jmergemap.size();

    // collect traces into a vector of vector whether we are dealling
    // with all traces or honoring tags.
    std::vector<ITrace::vector> tracesv1, tracesv2;
    if (!nsets) {
        tracesv1.push_back(FrameTools::untagged_traces(one));
        tracesv2.push_back(FrameTools::untagged_traces(two));
        std::cerr << "FrameMerger: see frame: "<<one->ident()<<" no tags, whole frame\n";
    }
    else {
        std::cerr << "FrameMerger: see frame: "<<one->ident()<<" with tags:\n";
        for (int ind=0; ind<nsets; ++ind) {
            auto jtags = jmergemap[ind];
            std::string tag1 = jtags[0].asString();
            std::string tag2 = jtags[1].asString();
            std::string tag3 = jtags[2].asString();
            tracesv1.push_back(FrameTools::tagged_traces(one, tag1));
            tracesv2.push_back(FrameTools::tagged_traces(two, tag2));
            std::cerr << "\ttags: "
                      << tag1 << "[" << tracesv1.back().size() << "]"
                      << " + "
                      << tag2 << "[" << tracesv2.back().size() << "]"
                      << " -> " << tag3
                      << "\n";
        }
    }
        
    ITrace::vector out_traces;
    std::vector<IFrame::trace_list_t> tagged_trace_indices;
    
    // apply rule, collect info for tags even if we may not be
    // configured to honor them.

    auto rule = get<std::string>(m_cfg, "rule"); 
    if (rule == "replace") {

        for (size_t ind=0; ind<tracesv1.size(); ++ind) {
            auto& traces1 = tracesv1[ind];
            auto& traces2 = tracesv2[ind];
            
            std::unordered_map<int, ITrace::pointer> ch2tr;
            for (auto trace : traces2) {
                ch2tr[trace->channel()] = trace;
            }
            for (auto trace : traces1) { // now replace any from frame 1
                ch2tr[trace->channel()] = trace;
            }

            IFrame::trace_list_t tl;
            for (auto chtr : ch2tr) {
                tl.push_back(out_traces.size());
                out_traces.push_back(chtr.second);
            }
            tagged_trace_indices.push_back(tl);
        }            
    }
    if (rule == "include") {
        for (size_t ind=0; ind<tracesv1.size(); ++ind) {
            auto& traces1 = tracesv1[ind];
            auto& traces2 = tracesv2[ind];

            IFrame::trace_list_t tl;
            for (size_t trind=0; trind < traces1.size(); ++trind) {
                tl.push_back(out_traces.size());
                out_traces.push_back(traces1[trind]);
            }
            for (size_t trind=0; trind < traces2.size(); ++trind) {
                tl.push_back(out_traces.size());
                out_traces.push_back(traces2[trind]);
            }
            tagged_trace_indices.push_back(tl);
        }
    }

    auto sf = new SimpleFrame(two->ident(), two->time(), out_traces, two->tick());
    if (nsets) {
        for (int ind=0; ind<nsets; ++ind) {
            std::string otag = jmergemap[ind][2].asString();
            sf->tag_traces(otag, tagged_trace_indices[ind]);
        }
    }
    out = IFrame::pointer(sf);
    return true;
}

Member Data Documentation

Configuration WireCell::SigProc::FrameMerger::m_cfg

private

Definition at line 27 of file FrameMerger.h.

---

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

• wire-cell-build/sigproc/inc/WireCellSigProc/FrameMerger.h
• wire-cell-build/sigproc/src/FrameMerger.cxx