WireCell::Gen::DepoPlaneX Class Reference

#include <DepoPlaneX.h>

Public Types
typedef std::deque< IDepo::pointer >	frozen_queue_t
typedef DepoTauSortedSet	working_queue_t

Public Member Functions
	DepoPlaneX (double planex=0.0 *units::cm, double speed=1.6 *units::millimeter/units::microsecond)
IDepo::pointer	add (const IDepo::pointer &depo)
double	proper_time (IDepo::pointer depo) const
	The time a deposition would have if it drifts to the plane. More...
double	freezeout_time () const
void	freezeout ()
	Force any remaining "thawed" depos in the queue to be frozen out. More...
IDepo::vector	pop (double time)
const frozen_queue_t &	frozen_queue () const
const working_queue_t &	working_queue () const

Private Member Functions
void	drain (double time)
	Move all froze-out depos to the frozen queue. More...

Private Attributes
double	m_planex
double	m_speed
working_queue_t	m_queue
frozen_queue_t	m_frozen

Detailed Description

A DepoPlaneX collects depositions and drifts them to the given plane assuming a uniform drift velocity which is in the negative X direction.

It is assumed new depositions are added strictly in time order. They will then be drifted and maintained in the order of their time at the plane.

The time of the most recently added depo sets a high water mark in time at the plane such that all newly added depos must (causally) come later. Any depos older than this time are considered "frozen out" as nothing can change their ordering.

Definition at line 28 of file DepoPlaneX.h.

Member Typedef Documentation

typedef std::deque<IDepo::pointer> WireCell::Gen::DepoPlaneX::frozen_queue_t

Definition at line 30 of file DepoPlaneX.h.

typedef DepoTauSortedSet WireCell::Gen::DepoPlaneX::working_queue_t

Definition at line 31 of file DepoPlaneX.h.

Constructor & Destructor Documentation

Gen::DepoPlaneX::DepoPlaneX	(	double	planex = 0.0*units::cm,
		double	speed = 1.6*units::millimeter/units::microsecond
	)

Definition at line 6 of file DepoPlaneX.cxx.

    : m_planex(planex)
    , m_speed(speed)
    , m_queue(IDepoDriftCompare(speed))
{
}

Member Function Documentation

IDepo::pointer Gen::DepoPlaneX::add

(

const IDepo::pointer &

depo

)

Add a deposition and drift it into the queue at the plane. Depos must be strictly added in (local) time order. The drifted depo is returned (and held).

Definition at line 14 of file DepoPlaneX.cxx.

{
    drain(depo->time());
    IDepo::pointer newdepo(new TransportedDepo(depo, m_planex, m_speed));
    m_queue.insert(newdepo);
    return newdepo;
}

void Gen::DepoPlaneX::drain ( double  time )

private

Move all froze-out depos to the frozen queue.

Definition at line 30 of file DepoPlaneX.cxx.

{
    IDepo::vector doomed;
    for (auto depo : m_queue) {
        if (depo->time() < time) {
            m_frozen.push_back(depo);
            doomed.push_back(depo);
        }
    }
    for (auto depo : doomed) {
        m_queue.erase(depo);
    }
}

void Gen::DepoPlaneX::freezeout

(

)

Force any remaining "thawed" depos in the queue to be frozen out.

Definition at line 44 of file DepoPlaneX.cxx.

{
    IDepo::vector doomed;
    for (auto depo : m_queue) {
        m_frozen.push_back(depo);
        doomed.push_back(depo);

    }
    for (auto depo : doomed) {
        m_queue.erase(depo);
    }
}

double Gen::DepoPlaneX::freezeout_time

(

)

const

Return the time at the plane before which the order of collected depositions are guaranteed (causally) to remain unchanged as any new depos are added.

Definition at line 22 of file DepoPlaneX.cxx.

{
    if (m_frozen.empty()) {
        return -1.0*units::second;
    }
    return m_frozen.back()->time();
}

const frozen_queue_t& WireCell::Gen::DepoPlaneX::frozen_queue ( ) const

inline

Definition at line 60 of file DepoPlaneX.h.

{ return m_frozen; }

IDepo::vector Gen::DepoPlaneX::pop

(

double

time

)

Return ordered vector of all depositions at the plane with times not later than the given time. The given time is typically the freezeout time. If a time later than the freezout time is given it may cause depos to be artificially frozen out.

Definition at line 57 of file DepoPlaneX.cxx.

{
    drain(time);
    auto found = std::find_if_not (m_frozen.begin(), m_frozen.end(), [time](IDepo::pointer p){return p->time() <= time;} );
    IDepo::vector ret(m_frozen.begin(), found);
    m_frozen.erase(m_frozen.begin(), found);
    return ret;
}

double WireCell::Gen::DepoPlaneX::proper_time

(

IDepo::pointer

depo

)

const

The time a deposition would have if it drifts to the plane.

const working_queue_t& WireCell::Gen::DepoPlaneX::working_queue ( ) const

inline

Definition at line 61 of file DepoPlaneX.h.

{ return m_queue; }

Member Data Documentation

frozen_queue_t WireCell::Gen::DepoPlaneX::m_frozen

private

Definition at line 66 of file DepoPlaneX.h.

double WireCell::Gen::DepoPlaneX::m_planex

private

Definition at line 64 of file DepoPlaneX.h.

working_queue_t WireCell::Gen::DepoPlaneX::m_queue

private

Definition at line 65 of file DepoPlaneX.h.

double WireCell::Gen::DepoPlaneX::m_speed

private

Definition at line 64 of file DepoPlaneX.h.

---

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

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