WireCell::Gen::FrameSummer Class Reference

#include <FrameSummer.h>

Inheritance diagram for WireCell::Gen::FrameSummer:

Public Member Functions
	FrameSummer ()
virtual	~FrameSummer ()
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
double	m_toffset
bool	m_align

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 12 of file FrameSummer.h.

Constructor & Destructor Documentation

Gen::FrameSummer::FrameSummer

(

)

Definition at line 62 of file FrameSummer.cxx.

    : m_toffset(0.0)
    , m_align(false)

{
}

Gen::FrameSummer::~FrameSummer ( )

virtual

Definition at line 69 of file FrameSummer.cxx.

{
}

Member Function Documentation

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

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 30 of file FrameSummer.cxx.

{
    m_align = get(cfg, "align", m_align);
    m_toffset = get(cfg, "offset", m_toffset);
}

Configuration Gen::FrameSummer::default_configuration ( ) const

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 12 of file FrameSummer.cxx.

{
    // fixme: maybe add operators, scaleing, offsets.

    Configuration cfg;

    // if true, the time of the second frame is ignored in favor of
    // the first.  Does not affect "tbin" values of individual traces.
    cfg["align"] = m_align;        

    // Amount of time offset to apply to the time of the second frame.
    // If frame two is "aligned" then this offset is applied to frame
    // two relative to the time of frame one
    cfg["offset"] = m_toffset;

    return cfg;
}

bool Gen::FrameSummer::operator() ( const input_tuple_type &  intup, output_pointer &  out  )

virtual

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

Definition at line 36 of file FrameSummer.cxx.

{
    auto one = std::get<0>(intup);
    auto two = std::get<1>(intup);
    if (!one or !two) {
        // assume eos
        out = nullptr;
        return true;
    }

    double t2 = two->time();
    if (m_align) {
        t2 = one->time();
    }
    t2 += m_toffset;

    auto vtraces2 = two->traces();
    ITrace::vector out_traces(vtraces2->begin(), vtraces2->end());
    auto newtwo = std::make_shared<SimpleFrame>(two->ident(), t2, out_traces, two->tick());

    out = Gen::sum(IFrame::vector{one,two}, one->ident());
    return true;
}

Member Data Documentation

bool WireCell::Gen::FrameSummer::m_align

private

Definition at line 26 of file FrameSummer.h.

double WireCell::Gen::FrameSummer::m_toffset

private

Definition at line 25 of file FrameSummer.h.

---

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

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