WireCellToolkit
Wire Cell Simulation, Signal Process and Reconstruction Toolki for Liquid Argon Detectors
WireCell::WireSummary Class Reference

#include <WireSummary.h>

Inheritance diagram for WireCell::WireSummary:
Collaboration diagram for WireCell::WireSummary:

Classes

struct  WireSummaryCache
 

Public Member Functions

 WireSummary (const IWire::vector &wires)
 
virtual ~WireSummary ()
 
virtual const BoundingBoxbox () 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 Vectorpitch_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 ()
 

Additional Inherited Members

- Public Types inherited from WireCell::IData< IWireSummary >
typedef IWireSummary value_type
 
typedef std::shared_ptr< const IWireSummarypointer
 
typedef std::vector< pointervector
 
typedef std::shared_ptr< const vectorshared_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::WireSummary ( const IWire::vector wires)

Definition at line 189 of file WireSummary.cxx.

◆ ~WireSummary()

WireSummary::~WireSummary ( )
virtual

Definition at line 194 of file WireSummary.cxx.

Member Function Documentation

◆ bounding_wires()

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.

Here is the call graph for this function:

◆ box()

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.

◆ by_channel()

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.

◆ closest()

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.

Here is the call graph for this function:

◆ pitch_direction()

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.

Here is the call graph for this function:

◆ pitch_distance()

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.

Here is the call graph for this function:

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