WireCell::Gen::TimeGatedDepos Class Reference

#include <TimeGatedDepos.h>

Inheritance diagram for WireCell::Gen::TimeGatedDepos:

Public Member Functions
	TimeGatedDepos ()
virtual	~TimeGatedDepos ()
virtual bool	operator() (const input_pointer &depo, output_queue &outq)
	The calling signature: More...
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::IDrifter
virtual	~IDrifter ()
virtual std::string	signature ()
Public Member Functions inherited from WireCell::IQueuedoutNode< IDepo, IDepo >
virtual	~IQueuedoutNode ()
virtual bool	operator() (const boost::any &anyin, queuedany &outanyq)
	The calling signature: More...
virtual std::vector< std::string >	input_types ()
virtual std::vector< std::string >	output_types ()
Public Member Functions inherited from WireCell::IQueuedoutNodeBase
virtual	~IQueuedoutNodeBase ()
virtual NodeCategory	category ()
	Return the behavior category type. More...
virtual int	concurrency ()
	By default assume all subclasses maintain state. 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
bool	m_accept
double	m_period
double	m_start
double	m_duration

Additional Inherited Members
Public Types inherited from WireCell::IDrifter
typedef std::shared_ptr< IDrifter >	pointer
Public Types inherited from WireCell::IQueuedoutNode< IDepo, IDepo >
typedef std::shared_ptr< IQueuedoutNodeBase >	pointer
typedef IDepo	input_type
typedef IDepo	output_type
typedef std::shared_ptr< const IDepo >	input_pointer
typedef std::shared_ptr< const IDepo >	output_pointer
typedef std::deque< output_pointer >	output_queue
Public Types inherited from WireCell::IQueuedoutNodeBase
typedef std::shared_ptr< IQueuedoutNodeBase >	pointer
typedef std::deque< boost::any >	queuedany
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

TimeGatedDepos outputs depos which pass a time based selection.

The selection is defined as a time gate expressed as a start time and a duration.

If a period is provided than the time gate is advanced by the configured period each time an EOS is received.

It operates in one of accept or reject modes. To be output in the former mode depos must have times within the gate, in the latter they must not.

The gate is half inclusive. Depo landing exactly at the end of the gate is considered outside the gate.

Definition at line 33 of file TimeGatedDepos.h.

Constructor & Destructor Documentation

Gen::TimeGatedDepos::TimeGatedDepos

(

)

Definition at line 36 of file TimeGatedDepos.cxx.

    : m_accept(true)
    , m_period(0.0)
    , m_start(0.0)
    , m_duration(0.0)

{
}

Gen::TimeGatedDepos::~TimeGatedDepos ( )

virtual

Definition at line 44 of file TimeGatedDepos.cxx.

{
}

Member Function Documentation

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

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 64 of file TimeGatedDepos.cxx.

{
    m_accept = cfg["accept"].asString() == "accept";
    m_period = get(cfg, "period", m_period);
    m_start = get(cfg, "start", m_start);
    m_duration = get(cfg, "duration", m_duration);
}

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

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 24 of file TimeGatedDepos.cxx.

{
    Configuration cfg;
    cfg["accept"] = m_accept;
    cfg["period"] = m_period;
    cfg["start"] = m_start;
    cfg["duration"] = m_duration;
    return cfg;
}

bool Gen::TimeGatedDepos::operator() ( const input_pointer &  in, output_queue &  outq  )

virtual

The calling signature:

Implements WireCell::IQueuedoutNode< IDepo, IDepo >.

Definition at line 48 of file TimeGatedDepos.cxx.

{
    if (!depo) {
        m_start += m_period;
        outq.push_back(nullptr);
        return true;
    }

    const double t = depo->time();
    const bool ingate = m_start <= t && t < m_start + m_duration;
    if (ingate == m_accept) {
        outq.push_back(depo);
    }
    return true;    
}

Member Data Documentation

bool WireCell::Gen::TimeGatedDepos::m_accept

private

Definition at line 42 of file TimeGatedDepos.h.

double WireCell::Gen::TimeGatedDepos::m_duration

private

Definition at line 45 of file TimeGatedDepos.h.

double WireCell::Gen::TimeGatedDepos::m_period

private

Definition at line 43 of file TimeGatedDepos.h.

double WireCell::Gen::TimeGatedDepos::m_start

private

Definition at line 44 of file TimeGatedDepos.h.

---

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

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