WireCell::Gen::Retagger Class Reference

#include <Retagger.h>

Inheritance diagram for WireCell::Gen::Retagger:

Public Member Functions
	Retagger ()
virtual	~Retagger ()
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() (const input_pointer &inframe, output_pointer &outframe)
	The calling signature: 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
tagrules::Context	m_trctx

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 40 of file Retagger.h.

Constructor & Destructor Documentation

Gen::Retagger::Retagger

(

)

Definition at line 10 of file Retagger.cxx.

{
}

Gen::Retagger::~Retagger ( )

virtual

Definition at line 14 of file Retagger.cxx.

{
}

Member Function Documentation

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

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 18 of file Retagger.cxx.

{
    // frame/trace/merge tagging.  
    m_trctx.configure(cfg["tag_rules"]);
}

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

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 24 of file Retagger.cxx.

{
    Configuration cfg;
    cfg["tag_rules"] = Json::arrayValue;
    return cfg;
}

bool Gen::Retagger::operator() ( const input_pointer &  in, output_pointer &  out  )

virtual

The calling signature:

Implements WireCell::IFunctionNode< IFrame, IFrame >.

Definition at line 31 of file Retagger.cxx.

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

    // Basic frame data is just shunted across.
    auto sfout = new SimpleFrame(inframe->ident(), inframe->time(), *inframe->traces(), inframe->tick());

    //
    // frame
    auto fintags = inframe->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("");
    auto fouttags = m_trctx.transform(0, "frame", fintags);
    for (auto ftag : fouttags) {
        sfout->tag_frame(ftag);
    }

    //
    // trace
    for (auto inttag : inframe->trace_tags()) {
        tagrules::tagset_t touttags = m_trctx.transform(0, "trace", inttag);
        if (touttags.empty()) {
            continue;
        }
        const auto& traces = inframe->tagged_traces(inttag);
        const auto& summary = inframe->trace_summary(inttag);
        for (auto otag : touttags) {
            sfout->tag_traces(otag, traces, summary);
        }
    }

    //
    // merge
    typedef std::tuple<tagrules::tag_t, IFrame::trace_list_t, IFrame::trace_summary_t> tag_trace_list_summary_t;
    typedef std::vector< tag_trace_list_summary_t > ttls_stash_t;
    typedef std::unordered_map<std::string, ttls_stash_t> ttls_stash_map_t;
    ttls_stash_map_t stashmap;
    for (auto inttag : inframe->trace_tags()) {
        tagrules::tagset_t touttags = m_trctx.transform(0, "merge", inttag);
        // std::cerr << "Retagger: " << inttag << " -> " << touttags.size() << " outtags\n";
        if (touttags.empty()) {
            continue;
        }
        const auto& traces = inframe->tagged_traces(inttag);
        const auto& summary = inframe->trace_summary(inttag);
        for (auto otag : touttags) {
          stashmap[otag].push_back(std::make_tuple(inttag, traces, summary));
        }
    }
    for (auto it : stashmap) {
        auto& otag = it.first;
        auto& stashv = it.second;
        size_t ntraces = 0, nsummary=0;
        // If at least one summary is not empty we must assure output
        // summary is aligned with output trace index vector.
        // Otherwise, we assume input plays by the rules and keeps
        // size of traces and summary equal.
        for (auto& ttls : stashv) {
            ntraces += get<1>(ttls).size();
            nsummary += get<2>(ttls).size();
        }
        IFrame::trace_list_t otraces;
        otraces.reserve(ntraces);
        IFrame::trace_summary_t osummary;
        if (nsummary > 0) {
            osummary.reserve(ntraces);
        }
        for (auto& ttls : stashv) { // one more time
            auto& traces = get<1>(ttls);
            otraces.insert(otraces.end(), traces.begin(), traces.end());

            // std::cerr << "Retagger: merge: " << get<0>(ttls) << " -> " << otag
            //          << " with " << otraces.size() << " / " << ntraces << std::endl;
            if (!nsummary) {
                continue;
            }
            auto& summary = get<2>(ttls);
            if (summary.empty()) {
                for (size_t ind=0; ind<traces.size(); ++ind) {
                    summary.push_back(0); // zero pad to cover missing summary and keep alignment with traces.
                }
            }
            else {
                osummary.insert(osummary.end(), summary.begin(), summary.end());
            }
        }
        std::cerr << "Retagger: tagging trace set: " << otag
                 << " with " << otraces.size() << " traces, " << osummary.size() << " summary\n";
                 
        sfout->tag_traces(otag, otraces, osummary);
    }


    outframe = IFrame::pointer(sfout);
    return true;
}

Member Data Documentation

tagrules::Context WireCell::Gen::Retagger::m_trctx

private

Definition at line 51 of file Retagger.h.

---

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

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