#include <IWireSummary.h>
Public Member Functions | |
| virtual | ~IWireSummary () |
| virtual const BoundingBox & | box () const =0 |
| Return the bounding box of the wire planes. More... | |
| virtual IWire::pointer | closest (const Point &point, WirePlaneId wpid) const =0 |
| virtual IWirePair | bounding_wires (const Point &point, WirePlaneId wpid) const =0 |
| virtual double | pitch_distance (const Point &point, WirePlaneId wpid) const =0 |
| virtual const Vector & | pitch_direction (WirePlaneId wpid) const =0 |
| Return a unit vector along the direction of the pitch. More... | |
| virtual IWire::vector | by_channel (int channel) const =0 |
| Return all wires, in order of segment number, attached to the channel. More... | |
 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 IWireSummary > | pointer |
| typedef std::vector< pointer > | vector |
| typedef std::shared_ptr< const vector > | shared_vector |
Detailed Description
Interface to summary information about wires.
Note: the actual implementation of these are likely just a bunch of stand-alone functions. They are couched into a class in order to allow for caching optimization and to avoid having to constantly pass in the wires.
Definition at line 16 of file IWireSummary.h.
Constructor & Destructor Documentation
◆ ~IWireSummary()
|
virtual |
Definition at line 172 of file IfaceDesctructors.cxx.
Member Function Documentation
◆ bounding_wires()
|
pure 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.
Implemented in WireCell::WireSummary.
◆ box()
|
pure virtual |
Return the bounding box of the wire planes.
Implemented in WireCell::WireSummary.
◆ by_channel()
|
pure virtual |
Return all wires, in order of segment number, attached to the channel.
Implemented in WireCell::WireSummary.
◆ closest()
|
pure 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.
Implemented in WireCell::WireSummary.
◆ pitch_direction()
|
pure virtual |
Return a unit vector along the direction of the pitch.
Implemented in WireCell::WireSummary.
◆ pitch_distance()
|
pure virtual |
Return the distance along the pitch of the given wire plane to the given point as measured from the zeroth wire.
Implemented in WireCell::WireSummary.
The documentation for this class was generated from the following files:
- iface/inc/WireCellIface/IWireSummary.h
- iface/src/IfaceDesctructors.cxx
