WireCell::WireSummary Class Reference

#include <WireSummary.h>

Inheritance diagram for WireCell::WireSummary:

Classes
struct	WireSummaryCache

Public Member Functions
	WireSummary (const IWire::vector &wires)
virtual	~WireSummary ()
virtual const BoundingBox &	box () const
	Return the bounding box of the wire planes. More...
virtual IWire::pointer	closest (const Point &point, WirePlaneId wpid) const
virtual IWirePair	bounding_wires (const Point &point, WirePlaneId wpid) const
virtual double	pitch_distance (const Point &point, WirePlaneId wpid) const
virtual const Vector &	pitch_direction (WirePlaneId wpid) const
	Return a unit vector along the direction of the pitch. More...
virtual IWire::vector	by_channel (int channel) const
	Return all wires, in order of segment number, attached to the channel. More...
Public Member Functions inherited from WireCell::IWireSummary
virtual	~IWireSummary ()
Public Member Functions inherited from WireCell::IData< IWireSummary >
virtual	~IData ()

Private Attributes
WireSummaryCache *	m_cache

Additional Inherited Members
Public Types inherited from WireCell::IData< IWireSummary >
typedef IWireSummary	value_type
typedef std::shared_ptr< const IWireSummary >	pointer
typedef std::vector< pointer >	vector
typedef std::shared_ptr< const vector >	shared_vector

Detailed Description

Default WireSummary which is also a wire sink and a wire sequence.

Definition at line 10 of file WireSummary.h.

Constructor & Destructor Documentation

WireSummary::WireSummary

(

const IWire::vector &

wires

)

Definition at line 189 of file WireSummary.cxx.

    : m_cache(0)
{
    m_cache = new WireSummaryCache(wires);    
}

WireSummary::~WireSummary ( )

virtual

Definition at line 194 of file WireSummary.cxx.

{
}

Member Function Documentation

IWirePair WireSummary::bounding_wires ( const Point &  point, WirePlaneId  wpid  ) const

virtual

Return a pair of adjacent wires from the given plane which bound the given point along the pitch direction. The pair is ordered by increasing wire index number. If one or both sides of the point are unbound by wire (segments) the associated pointer will be zero. It is assumed the point is in the (Y-Z) bounding box of the wire plane.

Implements WireCell::IWireSummary.

Definition at line 126 of file WireSummary.cxx.

{
    if (!m_cache) {
        return IWirePair();
    }
    WirePlaneCache* wpc = m_cache->plane(wpid);
    if (!wpc) {
        return IWirePair();
    }

    IWire::pointer wire = closest(point, wpid);
    if (!wire) return IWirePair();

    int index = wire->index();

    Vector topoint = point - wire->ray().first;
    double dot = wpc->pitch_unit.dot(topoint);
    int other_index = index - 1;
    if (dot > 0) {
        other_index = index + 1;
    }

    IWire::pointer other_wire = wpc->wire_by_index(other_index);

    if (index < other_index) {
        return IWirePair(IWire::pointer(wire), IWire::pointer(other_wire));
    }
    return IWirePair(IWire::pointer(other_wire), IWire::pointer(wire));
}

const BoundingBox & WireSummary::box ( ) const

virtual

Return the bounding box of the wire planes.

Implements WireCell::IWireSummary.

Definition at line 103 of file WireSummary.cxx.

{
    if (!m_cache) {
        static BoundingBox bbdummy;
        return bbdummy;
    }
    return m_cache->bb;
}

IWire::vector WireSummary::by_channel ( int  channel ) const

virtual

Return all wires, in order of segment number, attached to the channel.

Implements WireCell::IWireSummary.

Definition at line 181 of file WireSummary.cxx.

{
    if (!m_cache) {
        return IWire::vector();
    }
    return m_cache->by_chan(channel);
}

IWire::pointer WireSummary::closest ( const Point &  point, WirePlaneId  wpid  ) const

virtual

Return the closest wire along the pitch direction to the given point in the given wire plane. It is assumed the point is in the (Y-Z) bounding box of the wire plane.

Implements WireCell::IWireSummary.

Definition at line 112 of file WireSummary.cxx.

{
    if (!m_cache) {
        return 0;
    }
    WirePlaneCache* wpc = m_cache->plane(wpid);
    if (!wpc) {
        return 0;
    }
    
    double dist = wpc->pitch_distance(point);
    return wpc->wire_by_index(dist/wpc->pitch_mag);
}

const Vector & WireSummary::pitch_direction ( WirePlaneId  wpid ) const

virtual

Return a unit vector along the direction of the pitch.

Implements WireCell::IWireSummary.

Definition at line 168 of file WireSummary.cxx.

{
    static Vector dummy;
    if (!m_cache) {
        return dummy;
    }
    WirePlaneCache* wpc = m_cache->plane(wpid);
    if (!wpc) {
        return dummy;
    }
    return wpc->pitch_unit;
}

double WireSummary::pitch_distance ( const Point &  point, WirePlaneId  wpid  ) const

virtual

Return the distance along the pitch of the given wire plane to the given point as measured from the zeroth wire.

Implements WireCell::IWireSummary.

Definition at line 156 of file WireSummary.cxx.

{
    if (!m_cache) {
        return 0;
    }
    WirePlaneCache* wpc = m_cache->plane(wpid);
    if (!wpc) {
        return 0;
    }
    return wpc->pitch_distance(point);
}

Member Data Documentation

WireSummaryCache* WireCell::WireSummary::m_cache

private

Definition at line 42 of file WireSummary.h.

---

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

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