WireCell::SigProc::ChannelSelector Class Reference

#include <ChannelSelector.h>

Inheritance diagram for WireCell::SigProc::ChannelSelector:

Public Member Functions
	ChannelSelector ()
virtual	~ChannelSelector ()
virtual bool	operator() (const input_pointer &in, output_pointer &out)
	IFrameFilter interface. More...
virtual void	configure (const WireCell::Configuration &config)
	IConfigurable interface. 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 ()

Protected Member Functions
virtual void	set_channels (const std::vector< int > &channels)

Private Attributes
std::vector< std::string >	m_tags
std::unordered_set< int >	m_channels
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 20 of file ChannelSelector.h.

Constructor & Destructor Documentation

ChannelSelector::ChannelSelector

(

)

Definition at line 15 of file ChannelSelector.cxx.

    : log(Log::logger("glue"))
{
}

ChannelSelector::~ChannelSelector ( )

virtual

Definition at line 20 of file ChannelSelector.cxx.

{
}

Member Function Documentation

void ChannelSelector::configure ( const WireCell::Configuration &  config )

virtual

IConfigurable interface.

Implements WireCell::IConfigurable.

Reimplemented in WireCell::SigProc::DBChannelSelector.

Definition at line 39 of file ChannelSelector.cxx.

{
    // tags need some order
    auto jtags = cfg["tags"];
    int ntags = jtags.size();
    m_tags.clear();
    m_tags.resize(ntags);
    for (int ind=0; ind<ntags; ++ind) {
        m_tags[ind] = jtags[ind].asString();
    }

    // channels are just a bag
    for (auto jchan : cfg["channels"]) {
        m_channels.insert(jchan.asInt());
    }
}

WireCell::Configuration ChannelSelector::default_configuration ( ) const

virtual

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

Only traces with channels in this array will be in the output.

Only traces with these tags will be in the output. If no tags are given then tags are not considered.

Reimplemented from WireCell::IConfigurable.

Reimplemented in WireCell::SigProc::DBChannelSelector.

Definition at line 25 of file ChannelSelector.cxx.

{
    Configuration cfg;

    /// Only traces with channels in this array will be in the output.
    cfg["channels"] = Json::arrayValue;

    /// Only traces with these tags will be in the output.  If no tags
    /// are given then tags are not considered.
    cfg["tags"] = Json::arrayValue;

    return cfg;
}

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

virtual

IFrameFilter interface.

Implements WireCell::IFunctionNode< IFrame, IFrame >.

Reimplemented in WireCell::SigProc::DBChannelSelector.

Definition at line 65 of file ChannelSelector.cxx.

{
    out = nullptr;
    if (!in) {
        log->debug("ChannelSelector: sees EOS");
        return true;            // eos
    }

    std::vector<ITrace::vector> tracesvin;

    size_t ntraces = 0;

    size_t ntags = m_tags.size();
    if (!ntags) {
        tracesvin.push_back(FrameTools::untagged_traces(in));
        log->debug("ChannelSelector: see frame: {} no tags, whole frame ({} traces out of {})",
                   in->ident(), tracesvin.back().size(), in->traces()->size());
        ntraces += tracesvin[0].size();
    }
    else {
        tracesvin.resize(ntags);
        std::stringstream ss;
        ss << "ChannelSelector: see frame: "<<in->ident() << " looking for " << ntags << " tags:";
        for (size_t ind=0; ind<ntags; ++ind) {
            std::string tag = m_tags[ind];
            tracesvin[ind] = FrameTools::tagged_traces(in, tag);
            ss << " " << tag << ":[" << tracesvin[ind].size() << " traces]";
            ntraces += tracesvin[ind].size();
        }
        log->debug(ss.str());
    }
    if (!ntraces) {
        log->warn("ChannelSelector: see no traces from frame {}", in->ident());
    }

        
    ITrace::vector out_traces;
    std::vector<IFrame::trace_list_t> tagged_trace_indices;

    for (size_t ind=0; ind<tracesvin.size(); ++ind) {
        auto& traces = tracesvin[ind];

        IFrame::trace_list_t tl;
        for (size_t trind=0; trind < traces.size(); ++trind) {
            auto& trace = traces[trind];
            if (m_channels.find(trace->channel()) == m_channels.end()) {
                continue;
            }
            tl.push_back(out_traces.size());
            out_traces.push_back(trace);
        }
        tagged_trace_indices.push_back(tl);
    }

    std::stringstream taginfo;

    auto sf = new SimpleFrame(in->ident(), in->time(), out_traces, in->tick());
    if (ntags) {
        for (size_t ind=0; ind<ntags; ++ind) {
            std::string tag = m_tags[ind];
            sf->tag_traces(tag, tagged_trace_indices[ind]);
            taginfo << tag << " ";
        }
    }
    for(auto ftag: in->frame_tags()){
        sf->tag_frame(ftag);
        taginfo << "frame tag: " << ftag;
    }

    out = IFrame::pointer(sf);
    log->debug("ChannelSelector: producing {} traces, tags: {}",
               out->traces()->size(), taginfo.str());

    return true;
}

void ChannelSelector::set_channels ( const std::vector< int > &  channels )

protectedvirtual

Definition at line 56 of file ChannelSelector.cxx.

{
    m_channels.clear();
    for(int ch : channels) {
        m_channels.insert(ch);
    }
}

Member Data Documentation

Log::logptr_t WireCell::SigProc::ChannelSelector::log

private

Definition at line 40 of file ChannelSelector.h.

std::unordered_set<int> WireCell::SigProc::ChannelSelector::m_channels

private

Definition at line 38 of file ChannelSelector.h.

std::vector<std::string> WireCell::SigProc::ChannelSelector::m_tags

private

Definition at line 37 of file ChannelSelector.h.

---

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

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